🔒
Requires read_product access scope.

The List Suppliers API allows users to retrieve a list of suppliers with optional filtering by specific supplier IDs. The API supports pagination to handle large datasets and returns detailed information about suppliers, including their metadata.

This API is especially useful for:

Fetching a list of suppliers for inventory and procurement purposes.
Retrieving specific suppliers by their unique IDs.
Supporting pagination for managing large supplier datasets.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Query Parameters

Parameter	Type	Required	Default	Description	Example
`cursor`	`string`	No	`null`	Pagination cursor for next page	`"next_page_token"`
`page_size`	`int32`	No	`10`	Number of results per page (1-100)	`25`
`ids`	`array[string]`	No	`[]`	Filter by specific supplier IDs	`["sup_123", "sup_456"]`

Response Description

Public Response Fields

📘
Public Response Parameters

Success Response

Field	Type	Example	Description
`code`	string	`"success"`	Response status code
`message`	string		Descriptive message of the response
`data.cursor`	string	`"cursor_123"`	Pagination token
`data.has_more`	boolean	`true`	More results available
`data.suppliers`	array of Supplier object		List of addresses

Supplier Object

Parameter	Type	Example	Description
`id`	`string`	`"sup_123"`	Unique supplier identifier
`title`	`string`	`"Acme Supplies"`	Name of the supplier
`url`	`string`	`"https://acme.example.com"`	Supplier website URL
`created_at`	`string`	`"2025-01-01T00:00:00Z"`	Creation timestamp (ISO 8601)
`updated_at`	`string`	`"2025-01-02T12:00:00Z"`	Last update timestamp (ISO 8601)

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message

API Structure Overview

200OK