Suppliers

Supported Formats

json
>>>

GET /api/v2/suppliers.json
Retrieves a list of suppliers

Supported Formats

json

Examples

Response Example:

HTTP/1.1 200 OK
{
  "suppliers": [
    {
      "id": 1,
      "name": "Paper Supplier",
      "created_at": "2022-01-01T01:20:30.000Z",
      "updated_at": "2022-01-02T02:30:40.000Z",
      "company_name": "Reams R Us",
      "account_number": "456942",
      "contact_name": "John Doe",
      "contact_email": "john@example.com",
      "address1": "456 Fake Rd",
      "address2": "Unit 2000",
      "city": "New York",
      "province_code": "NY",
      "country_name": "United States",
      "zip": "12345",
      "phone": "456-789-1234",
      "phone_toll_free": "1-800-456-7890",
      "fax": "1-465-789-1234",
      "is_hidden": false
    },
    {
      "id": 2,
      "name": "Metal Supplier",
      "created_at": "2022-01-01T01:20:30.000Z",
      "updated_at": "2022-01-02T02:30:40.000Z",
      "company_name": "Sheet Metal Inc",
      "account_number": "564234",
      "contact_name": "Jane Smith",
      "contact_email": "jane@example.com",
      "address1": "123 Fake St",
      "address2": "Unit 101",
      "city": "Scranton",
      "province_code": "PA",
      "country_name": "United States",
      "zip": "67890",
      "phone": "123-456-7890",
      "phone_toll_free": "1-800-789-4567",
      "fax": "1-123-456-7890",
      "is_hidden": true
    }
  ]
}

Params

Param name Description
limit
optional

The maximum number of records to return.

Default Value: 50

Maximum Value: 250

Validations:

  • Must be a Integer
since_id
optional

Return only suppliers with ID values greater than the provided ID. Use in combination with the limit parameter for pagination.

Validations:

  • Must be a Integer
updated_since
optional

Return only suppliers that have been updated on or after a specified date (Using ISO 8601 format; e.g. 2014-04-25T16:15:47-04:00)

Validations:

  • Must be a String

Returns

Code: 200

Description:

The requested supplier data

Param name Description
id
required

“id”: 808950810

A unique numeric identifier for the supplier.

Validations:

  • Must be a Integer
name
required

“name”: “Paper Supplier”

The name of the Supplier in Stocky.

Validations:

  • Must be a String
created_at
required

“created_at”: “2021-02-05T17:55:46.000Z”

The date and time (ISO 8601 format) when the supplier was created.

Validations:

  • Must be a String
updated_at
required

“updated_at”: “2021-02-09T19:47:30.000Z”

The date and time (ISO 8601 format) when the supplier was last updated.

Validations:

  • Must be a String
company_name
required

“company_name”: “Reams R Us”

The company name of the supplier.

Validations:

  • Must be a String
account_number
required

“account_number”: “12345”

The account number associated with the supplier.

Validations:

  • Must be a String
contact_name
required

“contact_name”: “John Doe”

The name of the point of contact for the supplier.

Validations:

  • Must be a String
contact_email
required

“contact_email”: “john@example.com”

The email address of the point of contact for the supplier.

Validations:

  • Must be a String
address1
required

“address1”: “123 Fake St”

The first address line for the supplier.

Validations:

  • Must be a String
address2
required

“address2”: “Unit 100”

The second address line for the supplier.

Validations:

  • Must be a String
city
required

“city”: “New York”

The city associated with the suppliers address.

Validations:

  • Must be a String
province_code
required

“province_code”: “NY”

The province, state or territory associated with the suppliers address.

Validations:

  • Must be a String
country_name
required

“country_name”: “United States”

The country associated with the suppliers address.

Validations:

  • Must be a String
zip
required

“zip”: “12345”

The zip or postal code associated with the suppliers address.

Validations:

  • Must be a String
phone
required

“phone”: “123-456-7890”

The phone number of the supplier.

Validations:

  • Must be a String
phone_toll_free
required

“phone_toll_free”: “1-800-123-4567”

The toll free phone number of the supplier.

Validations:

  • Must be a String
fax
required

“fax”: “1-234-567-8901”

The fax number of the supplier.

Validations:

  • Must be a String
is_hidden
required

“is_hidden”: false

Whether or not the supplier is hidden within the Stocky app.

Validations:

  • Must be one of: true, false, 1, 0.
>>>

GET /api/v2/suppliers/{supplier_id}.json
Retrieves a single supplier by ID

Supported Formats

json

Errors

Code Description
404 No supplier found

Examples

Response Example:

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "Paper Supplier",
  "created_at": "2022-01-01T01:20:30.000Z",
  "updated_at": "2022-01-02T02:30:40.000Z",
  "company_name": "Reams R Us",
  "account_number": "456942",
  "contact_name": "John Doe",
  "contact_email": "john@example.com",
  "address1": "456 Fake Rd",
  "address2": "Unit 2000",
  "city": "New York",
  "province_code": "NY",
  "country_name": "United States",
  "zip": "12345",
  "phone": "456-789-1234",
  "phone_toll_free": "1-800-456-7890",
  "fax": "1-465-789-1234",
  "is_hidden": false
}

Params

Param name Description
id
required

The ID of the supplier.

Validations:

  • Must be a number.

Returns

Code: 200

Description:

The requested supplier data

Param name Description
id
required

“id”: 808950810

A unique numeric identifier for the supplier.

Validations:

  • Must be a Integer
name
required

“name”: “Paper Supplier”

The name of the Supplier in Stocky.

Validations:

  • Must be a String
created_at
required

“created_at”: “2021-02-05T17:55:46.000Z”

The date and time (ISO 8601 format) when the supplier was created.

Validations:

  • Must be a String
updated_at
required

“updated_at”: “2021-02-09T19:47:30.000Z”

The date and time (ISO 8601 format) when the supplier was last updated.

Validations:

  • Must be a String
company_name
required

“company_name”: “Reams R Us”

The company name of the supplier.

Validations:

  • Must be a String
account_number
required

“account_number”: “12345”

The account number associated with the supplier.

Validations:

  • Must be a String
contact_name
required

“contact_name”: “John Doe”

The name of the point of contact for the supplier.

Validations:

  • Must be a String
contact_email
required

“contact_email”: “john@example.com”

The email address of the point of contact for the supplier.

Validations:

  • Must be a String
address1
required

“address1”: “123 Fake St”

The first address line for the supplier.

Validations:

  • Must be a String
address2
required

“address2”: “Unit 100”

The second address line for the supplier.

Validations:

  • Must be a String
city
required

“city”: “New York”

The city associated with the suppliers address.

Validations:

  • Must be a String
province_code
required

“province_code”: “NY”

The province, state or territory associated with the suppliers address.

Validations:

  • Must be a String
country_name
required

“country_name”: “United States”

The country associated with the suppliers address.

Validations:

  • Must be a String
zip
required

“zip”: “12345”

The zip or postal code associated with the suppliers address.

Validations:

  • Must be a String
phone
required

“phone”: “123-456-7890”

The phone number of the supplier.

Validations:

  • Must be a String
phone_toll_free
required

“phone_toll_free”: “1-800-123-4567”

The toll free phone number of the supplier.

Validations:

  • Must be a String
fax
required

“fax”: “1-234-567-8901”

The fax number of the supplier.

Validations:

  • Must be a String
is_hidden
required

“is_hidden”: false

Whether or not the supplier is hidden within the Stocky app.

Validations:

  • Must be one of: true, false, 1, 0.