🔒

Requires create_product access scope. More access scope

The Update Supplier API updates the details of an existing supplier by its unique identifier (id). This endpoint is useful for modifying supplier information such as the URL, allowing users to maintain accurate supplier data.This API is especially useful for:

1. Updating supplier information for procurement or inventory purposes.
2. Ensuring supplier records are up-to-date with accurate data.

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.

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

Body 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 PUT \
     --url https://{shopdomain}.myshoplazza.com/openapi/2022-01/suppliers/{id} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'access-token: <YOUR_ACCESS_TOKEN>' \
     --data '{
         "supplier": {
             "url": "https://shoplazza.com"
         }
     }'

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