List suppliers
Changed onRetrieve a paginated list of all suppliers with optional filtering by supplier name.
Request
- Base URLhttps://api.shipstation.com
- URLhttps://api.shipstation.com/v2/suppliers
- AuthAPI key in header api-key
Query parameters
Filter by supplier name (partial match)
Number of results per page
Response
The request was a success.
Example response
{
"suppliers": [
{
"supplier_id": "se-567",
"supplier_name": "Acme Widgets Inc",
"supplier_email": "orders@acmewidgets.com",
"address_line_1": "123 Main St",
"address_line_2": "Suite 100",
"city": "Austin",
"state": "TX",
"postal_code": "78701",
"country_code": "US",
"contact_name": "John Doe",
"contact_phone": "512-555-0100"
}
],
"total": 25,
"page": 2,
"pages": 3,
"links": {
"first": {
"href": "https://api.shipstation.com/v2/suppliers?page_size=50"
},
"next": {
"href": "https://api.shipstation.com/v2/suppliers?cursor=eyJQYWdlIjoyLCJTdXBwbGllck5hbWUiOm51bGx9"
}
}
}Changes
- warning
added the new
bring_your_own_label_not_supportedenum value to the//response property for the response status - warning
added the new
multiple_sales_ordersenum value to the//response property for the response status - warning
added the new
sales_order_link_requiredenum value to the//response property for the response status
- warning
- breaking
the
/response's property type changed from no type toobjectfor status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
removed from the
/response propertyallOflist for the response status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status - info
added the required property
//to the response with the status
- breaking