Skip to content

Suppliers

Returns list of suppliers in the system. Returned data can be limited with id query parameters.

Operations

Download suppliers as JSON

Request

GET https://api.zoined.com/v2/download/suppliers.json?limit=1000&offset=0&supplier_id=123k

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
supplier_idstring

Returns data of suppliers based on the given id

Example:supplier_id=123k
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/suppliers.json?limit=1000&offset=0&supplier_id=123k' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
supplier_idstringrequired

Supplier ID

Example:"221"
supplier_namestring

Supplier name

Example:"WasSuppliers"
supplier_emailstring

Supplier Email

Example:"john.smith@supplier.supplier"
supplier_phonestring

Supplier phone number

Example:"+3581111111"
supplier_addressstring

Street address

Example:"Mannerheimintie 1"
supplier_citystring

City

Example:"Helsinki"
supplier_zipcodestring

Postal code

Example:"00100"
supplier_countrystring

Country

Example:"Finland"
supplier_typestring

Supplier type

Example:"Local"
supplier_groupstring

Supplier group

Example:"Strategic Supplier"
custom_field_1string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_2string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_3string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_4string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_5string

Field that can be used for custom dimensions

Example:"XYZ"
Response
{
  "supplier_id": "221",
  "supplier_name": "WasSuppliers",
  "supplier_email": "john.smith@supplier.supplier",
  "supplier_phone": "+3581111111",
  "supplier_address": "Mannerheimintie 1",
  "supplier_city": "Helsinki",
  "supplier_zipcode": "00100",
  "supplier_country": "Finland",
  "supplier_type": "Local",
  "supplier_group": "Strategic Supplier",
  "custom_field_1": "XYZ",
  "custom_field_2": "XYZ",
  "custom_field_3": "XYZ",
  "custom_field_4": "XYZ",
  "custom_field_5": "XYZ"
}