API 2.0
Fulfillment
Audit
Brands
Consignments
Customers
Channel request log
Customer Groups
Inventory
Outlet Product Taxes
Outlets
Payment Types
Price Books
Product Images
Product Types
Promotions
Registers
Retailers
Sales
Search
Suppliers
Tags
Taxes
Users
API 2.0 (BETA)
Powered by Stoplight
post

/products

Creates a new product.

Authorization

apiKey - Authorization

Request Body

Note: You cannot include both price_including_tax and price_excluding_tax.

1 Example
Schema
object
name
string

Product name.

required
description
string

A detailed description of the Product. Note Can contain HTML.

handle
string

Product handle. Note: Variants share the same handle.

required
sku
string

Product sku. Note: Should be unique, but it’s not verified while posting.

required
source
string

Indicates the origin of the product. Can be USER, SYSTEM, SHOPIFY.

source_id
string

External reference ID.

source_variant_id
string

Secondary external reference ID.

active
boolean

Indicated whether the Product is active.

has_inventory
boolean

Indicates whether inventory is being tracked for the Product.

is_composite
boolean

Indicates whether the Product is a composite one.

has_variants
boolean

Indicated whether product has variants.

variant_parent_id
string

This value is set if a Product is a variant of another Product.

1 validation
variant_name
string

The name of the variant product.

variant_options
array[object]

A list of variant option objects.

variant_count
integer

The number of variants for this product.

price_including_tax
number

The price including all the relevant taxes.

price_excluding_tax
number

The price before tax is added.

supply_price
number

Default supply price,

1 validation
supplier_id
string

The supplier ID.

1 validation
supplier_code
string

Supplier code.

supplier
object
product_type_id
string

The product type.

1 validation
type
object
brand_id
string

The brand ID.

1 validation
brand
object
tag_ids
array[string]

An array of tag IDs associated with this product.

categories
array[object]

A list of tag objects.

attributes
array[object]

A list of attributes

image_url
string
image_thumbnail_url
string
images
array[object]

A list of image objects.

account_code
string

The code used to attribute the sales of the product to a specific account for the Xero integration

account_code_purchase
string

The code used to attribute the purchase of the product to a specific account for the Xero integration

button_order
integer

Ordering sequence for displaying the list of variant products

loyalty_amount
number

The amount of loyalty the customer receives buying this item.

Responses

OK

1 Example
Schema
object
data
array

An array containing the ID or IDs of the new products.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
domain_prefix
$$.env
1 variable not set
Authorization