Create Product

Creates a product with its variants, location assignments, taxes and optional brand/category/supplier links. Requires the Create Products permission at every location the product is assigned to. The product type determines variant rules: non-variant types accept exactly one variant; kit products need exactly one variant with kit_items.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length ≤ 190
string
enum
required
Allowed:
string | null
integer | null
integer | null
integer | null
boolean
required
boolean
required
taxes
array of integers

Tax ids to apply to the product. May be empty.

taxes
locations
array of objects
required

Locations the product is sold at (at least one). Each entry is an object with id and an optional per-location reorder_limit.

locations*
online_locations
array of integers

Online (e-commerce) location ids to list the product on.

online_locations
string | null

First variant attribute name (e.g. "Size") for variant products. Names must be defined in order (1 before 2 before 3) and must be unique.

string | null
string | null
units
array of objects
required

Additional sale/stock units as {"name", "scale"} objects. Always send this key — use [] when the product only uses the default unit (omitting it entirely causes a server error).

units*
variants
array of objects
required

Variants to create (exactly one unless type is variant). Each entry supports sku, barcode, standard_cost (required), sales_price, unit_sales_prices, reorder_limit, company_reorder_limit, attr_value_1..3 (required for each defined attr_name_*), images (array of previously uploaded image file ids) and, for kit products, kit_items (variant_id, unit, unit_quantity).

variants*
Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

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