Requires read_product access scope. More 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.
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "Duplicated supplier name"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
Array
"store is not active"
Indicates an error encountered during the process.
Error Details
Status Code
Error Message
Possible Cause
Example Response
400
Bad Request
The request contains invalid input or is missing required fields.
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
