Create a Product

Create a single product in your account.

Required authorization scope: public.product:write

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid

Product ID

uuid | null

Store ID

string
length ≤ 500

Human-readable name of the product.

string | null
string
enum
Allowed:
string

SKU for the product. This should be unique per one store. Identifier is required when store_id or platform_product_id is empty.

double | null
> 0

Length of the product in cm (centimeters).

double | null
> 0

Width of the product in cm (centimeters).

double | null
> 0

Height of the product in cm (centimeters).

double | null
> 0

Weight of the product in kg (kilograms).

integer

Item Category ID

string | null

Platform Product ID (PPID). Unique identifier from your store platform (e.g. Shopify variant ID, WooCommerce product ID). Used to link shipment items to product catalog entries for auto-population of product attributes.

string | null

Manufacturer Part Number (MPN). The manufacturer's internal code or part number for the product. Useful for wholesale and B2B operations to identify products by their source.

string | null

Global Trade Item Number (GTIN). Internationally recognized unique identifier for trade items, including UPC (US/Canada), EAN (Europe), JAN (Japan), and ISBN (books). Used by retailers and carriers for product identification and inventory tracking.

double | null
> 0

Cost of the product.

string | null
enum

Product cost currency. ISO-4217 three-letter alphabetic currency code (e.g. USD, EUR, GBP).

double | null
> 0

Product selling price.

string | null
enum

Currency of the product selling price. ISO-4217 three-letter alphabetic currency code (e.g. USD, EUR, GBP).

string | null

Image URL of the product.

string | null
≤ 80

Pickup location for the product.

string | null
enum

Country where the product is manufactured. Country Code in Alpha-2 format (ISO 3166-1)

string | null
boolean | null

Check if the product contains liquid.

boolean | null

Check if the product should apply packing instruction 966.

boolean | null

Check if the product should apply packing instruction 967.

cpsc_compliance
object | null

CPSC compliance data to store on this product. All fields are optional -- partial data is accepted and does not block the product from being saved.

Important: fields are scoped to coc_type. Only the fields relevant to the current (or newly submitted) coc_type are ever persisted:

  • registered: certifier_identifier, version_identifier, product_identifier_type
  • unregistered: citation_code, certifier_identity, manufacturing_detail, manufacturing_date, testing_detail, laboratory, records_custodian, product_identifier_type
  • exempted: disclaim_code

Any field outside the resulting coc_type's group is silently cleared to null, whether it was left over from a previous update or submitted in the same request. This happens without an error, so a field you send may come back null in the response if it doesn't match the coc_type you set (or the product's existing coc_type, if you didn't change it). If you are switching coc_type, submit coc_type together with the new path's fields in the same request.

string
string
Responses

Language
Credentials
Bearer
token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json