Vendors

Retrieve all vendors

Retrieve all vendors for a company

get

/vendors

Query parameters

per_pageinteger

limit of records per page

Example: 10

pageinteger

page number

Example: 2

namestring

This field is used to filter by vendor name. (LIKE)

Example: Hay

sort_bystring

This parameter is used to sort the records by a specific field (created_at,name)

Example: name

sort_dirstring

Order type(asc or desc)

Example: asc

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://app.greenplaces.com/api/vendors'

200

400

403

404

500

200

{
  "status": "Ok",
  "message": "Success",
  "data": [
    {
      "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
      "name": "test name",
      "description": "description...",
      "website": "https://www.example.com/",
      "notes": "notes...",
      "services_provided": "example",
      "products_purchased": "example",
      "account_manager_name": "name manager",
      "account_manager_email": "[e-mail]",
      "currency": "USD",
      "score": "2",
      "updated_at": "2023-06-12T17:30:21.000000Z",
      "created_at": "2023-06-12T17:30:21.000000Z"
    }
  ],
  "meta": {
    "pagination": {
      "current": "1",
      "last_page": "1",
      "per_page": "10",
      "total": "6"
    }
  }
}

Successful operation

Store a vendor

Store a vendor for a company

post

/vendors

Body

namestringrequired

name of the Vendor

Example: test name

websitestringrequired

website of the Vendor

Example: https://www.example.com/

descriptionstring

description of the Vendor

Example: description...

notesstring

notes of the Vendor

Example: notes...

services_providedstring

services_provided of the Vendor

Example: example

products_purchasedstring

products_purchased of the Vendor

Example: example

account_manager_namestring

account_manager_name of the Vendor

Example: name manager

account_manager_emailstring

account_manager_email of the Vendor

Example: [e-mail]

currencystring

currency of the Vendor

Example: USD

scoreinteger

score of the Vendor

Example: 22

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://app.greenplaces.com/api/vendors' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "test name",
    "website": "https://www.example.com/",
    "description": "description...",
    "notes": "notes...",
    "services_provided": "example",
    "products_purchased": "example",
    "account_manager_name": "name manager",
    "account_manager_email": "[e-mail]",
    "currency": "USD",
    "score": "22"
  }'

200

400

403

404

500

200

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "name": "test name",
    "description": "description...",
    "website": "https://www.example.com/",
    "notes": "notes...",
    "services_provided": "example",
    "products_purchased": "example",
    "account_manager_name": "name manager",
    "account_manager_email": "[e-mail]",
    "currency": "USD",
    "score": "2",
    "updated_at": "2023-06-12T17:30:21.000000Z",
    "created_at": "2023-06-12T17:30:21.000000Z"
  },
  "meta": {}
}

Successful operation

Retrieve a vendor

Retrieve a vendor for a company

get

/vendors/{id}

Path parameters

idstringrequired

Id of the vendor

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://app.greenplaces.com/api/vendors/{id}'

200

400

403

404

500

200

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "name": "test name",
    "description": "description...",
    "website": "https://www.example.com/",
    "notes": "notes...",
    "services_provided": "example",
    "products_purchased": "example",
    "account_manager_name": "name manager",
    "account_manager_email": "[e-mail]",
    "currency": "USD",
    "score": "2",
    "updated_at": "2023-06-12T17:30:21.000000Z",
    "created_at": "2023-06-12T17:30:21.000000Z"
  },
  "meta": {}
}

Successful operation

Update a vendor

Update a vendor for a company

put

/vendors/{id}

Path parameters

idstringrequired

Id of the vendor

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Body

namestringrequired

name of the Vendor

Example: test name

websitestringrequired

website of the Vendor

Example: https://www.example.com/

descriptionstring

description of the Vendor

Example: description...

notesstring

notes of the Vendor

Example: notes...

services_providedstring

services_provided of the Vendor

Example: example

products_purchasedstring

products_purchased of the Vendor

Example: example

account_manager_namestring

account_manager_name of the Vendor

Example: name manager

account_manager_emailstring

account_manager_email of the Vendor

Example: [e-mail]

currencystring

currency of the Vendor

Example: USD

scoreinteger

score of the Vendor

Example: 22

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://app.greenplaces.com/api/vendors/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "test name",
    "website": "https://www.example.com/",
    "description": "description...",
    "notes": "notes...",
    "services_provided": "example",
    "products_purchased": "example",
    "account_manager_name": "name manager",
    "account_manager_email": "[e-mail]",
    "currency": "USD",
    "score": "22"
  }'

200

400

403

404

500

200

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "name": "test name",
    "description": "description...",
    "website": "https://www.example.com/",
    "notes": "notes...",
    "services_provided": "example",
    "products_purchased": "example",
    "account_manager_name": "name manager",
    "account_manager_email": "[e-mail]",
    "currency": "USD",
    "score": "2",
    "updated_at": "2023-06-12T17:30:21.000000Z",
    "created_at": "2023-06-12T17:30:21.000000Z"
  },
  "meta": {}
}

Successful operation

Delete vendor

remove vendor

delete

/vendors/{id}

Path parameters

idstringrequired

Id of the vendor

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://app.greenplaces.com/api/vendors/{id}'

200

400

403

404

500

200

{
  "status": "Ok",
  "message": "Success",
  "data": null,
  "meta": {}
}

Successful operation