🔒

Requires read_product access scope. More access scope

The Get Supplier Detail API retrieves the detailed information of a specific supplier by its unique identifier (id). This endpoint is useful for fetching supplier details such as name, URL, and creation and update timestamps for inventory or procurement management.This API is especially useful for:

1. Fetching supplier details for inventory tracking or procurement systems.
2. Validating supplier information for external systems.

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

Path 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/{id} \
     --header 'accept: application/json' \
     --header 'access-token: <YOUR_ACCESS_TOKEN>'

Success Response Example

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

Error Response Example

{
  "errors": [
    "invalid id"
  ]
}

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

Error Details