Create product

Creates a new product.

🔒 Requires: products:write scope

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

Note: You cannot include both price_including_tax and price_excluding_tax.

string

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

string

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

all_outlets_tax
object

Only used for tax inclusive stores.

attributes
object
string

The brand ID.

composite
array of objects

A list of composite components.

composite
string

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

string
enum

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

Allowed:
string

Product handle.

number

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

images
array of objects

A list of image objects.

images
inventory
array of objects
inventory
boolean

Indicated whether the Product is active.

number

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

number

The amount of loyalty the customer receives buying this item.

string
required

Product name. Note: Variants share the same name.

outlet_taxes
array of objects

Only used for tax exclusive stores.

outlet_taxes
number

The price before tax is added.

number

The price including all the relevant taxes.

string

The product category.

product_codes
array of objects
product_codes
product_suppliers
array of objects
product_suppliers
string

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

string

Product sku. Note: Should be unique.

string

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

string

External reference ID.

string

Secondary external reference ID.

string

Supplier code.

string

The supplier ID.

double

Default supply price.

tag_ids
array of strings

An array of tag IDs associated with this product.

tag_ids
variants
array of objects
variants
number

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

string
enum

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

Allowed:
number

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

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