🔒
Requires read_product access scope.

The Create Supplier API allows users to add a new supplier to the system, establishing a record for vendors that provide products or services.

This API is especially useful for:

Onboarding new vendors into the procurement system.
Creating detailed supplier profiles with basic contact information.
Establishing a centralized supplier database for supply chain management.

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.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Body Parameters

Parameter	Type	Required	Description	Example	Example
`supplier`	object	Yes	Object containing supplier details	`{...}`	`"next_page_token"`
`supplier.title`	string	Yes	Supplier's name, must be unique within the store	`Acme Corporation`	`["sup_123", "sup_456"]`
`supplier.url`	string	No	URL associated with the supplier	`https://acme.com`

Response Description

Public Response Fields

📘
Public Response Parameters

Success Response

Field	Type	Example	Description
`code`	string	`"success"`	Response status code
`message`	string		Descriptive message of the response
`data.supplier`	Supplier object		supplier

Supplier Object

Parameter	Type	Example	Description
`id`	`string`	`"sup_123"`	Unique supplier identifier
`title`	`string`	`"Acme Supplies"`	Name of the supplier
`url`	`string`	`"https://acme.example.com"`	Supplier website URL
`created_at`	`string`	`"2025-01-01T00:00:00Z"`	Creation timestamp (ISO 8601)
`updated_at`	`string`	`"2025-01-02T12:00:00Z"`	Last update timestamp (ISO 8601)

Error Response

Field	Type	Example	Description
`code`	string	`InvalidParameter`	Error http message
`message`	string	``	Error message

API Structure Overview

200OK