🔒

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:

1. Fetching a list of suppliers for inventory and procurement purposes.
2. Retrieving specific suppliers by their unique IDs.
3. 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 queries are applied to the correct store.

Public Request Parameters

Public Response Parameters

Error and Errors Clarification:

Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.

Request Parameters

Query Parameters

Response Explanation

Successful Response

Error Response

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.

Request Examples

curl --request GET \
     --url https://{shopdomain}.myshoplazza.com/openapi/2022-01/suppliers?ids=382453603865993516&page=1&limit=10 \
     --header 'accept: application/json' \
     --header 'access-token: <YOUR_ACCESS_TOKEN>'

Success Response Example

{
  "suppliers": [
    {
      "id": "382453603865993516",
      "title": "example supplier",
      "url": "https://shoplazza.com",
      "created_at": "2024-05-21T08:54:05Z",
      "updated_at": "2024-05-21T08:54:05Z"
    }
  ],
  "count": 1
}

Error Response Example

{
  "errors": [
     "Context Error"
  ]
}

{
  "error": "store is not active"
}

Error Details