Create product

post

https://{domain_prefix}.retail.lightspeed.app/api/2.0/products

Creates a new product.

🔒 Requires: products:write scope

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Note: You cannot include both price_including_tax and price_excluding_tax.

name

string

required

Product name. Note: Variants share the same name.

description

string

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

handle

string

Product handle.

sku

string

Product sku. Note: Should be unique.

product_codes

array of objects

product_codes

source

string

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

source_id

string

External reference ID.

source_variant_id

string

Secondary external reference ID.

is_active

boolean

Indicated whether the Product is active.

price_including_tax

number

The price including all the relevant taxes.

price_excluding_tax

number

The price before tax is added.

supply_price

double

Default supply price.

supplier_id

string

The supplier ID.

supplier_code

string

Supplier code.

product_suppliers

array of objects

product_suppliers

product_type_id

string

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

product_category_id

string

The product category.

brand_id

string

The brand ID.

tag_ids

array of strings

An array of tag IDs associated with this product.

tag_ids

attributes

object

An object containing attributes

images

array of objects

A list of image objects.

images

inventory

array of objects

inventory

account_code_sale

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.

loyalty_amount

number

The amount of loyalty the customer receives buying this item.

weight

number

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

weight_unit

string

enum

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

Allowed:

length

number

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

width

number

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

height

number

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

dimensions_unit

string

enum

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

Allowed:

variants

array of objects

variants

all_outlets_tax

object

Only used for tax inclusive stores.

outlet_taxes

array of objects

Only used for tax exclusive stores.

outlet_taxes

composite

array of objects

A list of composite components.

composite

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Example

200OK