🔒

Requires create_product access scope. More access scope

The Create Supplier API allows users to add a new supplier to the system. This API accepts detailed supplier information and stores it for inventory and procurement management.This API is especially useful for:

1. Adding new suppliers for inventory management and procurement purposes.
2. Maintaining a directory of external vendors or service providers.

Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all actions 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

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

Success Response Example

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

Error Response Example

{
  "errors": [
     "Duplicated supplier name"
  ]
}

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

Error Details