v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Products

Create product

Creates a new product.

🔒 Requires: products:write scope

post/products

Request body

account_code_purchasestring

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

account_code_salestring

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

brand_idstring UUID

The brand ID.

descriptionstring

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

dimensions_unit'IN' | 'CM' | 'MM' | 'YD'

Unit of measurement for product dimensions. These are used to calculate variable shipping rates for stores using Lightspeed eCom.

handlestring

Product handle.

heightnumber

Product height. These are used to calculate variable shipping rates for stores using Lightspeed eCom.

is_activeboolean

Indicated whether the Product is active.

lengthnumber

Product length. These are used to calculate variable shipping rates for stores using Lightspeed eCom.

loyalty_amountnumber

The amount of loyalty the customer receives buying this item.

namestring required

Product name. Note: Variants share the same name.

price_excluding_taxnumber

The price before tax is added.

price_including_taxnumber

The price including all the relevant taxes.

product_category_idstring UUID

The product category.

product_type_idstring UUID

The product category. Note Product types are now product categories.

skustring

Product sku. Note: Should be unique.

sourcestring

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

source_idstring

External reference ID.

source_variant_idstring

Secondary external reference ID.

supplier_codestring

Supplier code.

supplier_idstring UUID

The supplier ID.

supply_pricenumber double

Default supply price.

tag_idsstring[]

An array of tag IDs associated with this product.

weightnumber

Product weight. These are used to calculate variable shipping rates for stores using Lightspeed eCom.

weight_unit'CT' | 'G' | 'OZ' | 'LB' | 'KG'

Unit of measurement for product weight. These are used to calculate variable shipping rates for stores using Lightspeed eCom.

widthnumber

Product width. These are used to calculate variable shipping rates for stores using Lightspeed eCom.

Response

OK

datastring[]

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