Commerce Products

The Products Object

From the Products endpoint, you can retrieve a list of all products for a specified business.

Field

Type

Description

id
sortable, filterable

string

Unique identifier of the product.

type
sortable, filterable

string

Retail category that the product is assigned to.

name
filterable

string

Name of the Product.

description

string

Description of the product in the commerce platform.

productVariants

array

An array of product variants.

createdDate
sortable, filterable

string
See Date

Date the product was created in the commerce platform.

sourceModifiedDate
sortable, filterable

string
See Date

Date the product was las updated in the commerce platform.

status
sortable, filterable

string

Status of product.

isGiftCard
filterable

string

Indicates if the product is a gift card.

Product Variants

Field

Type

Description

id

string

Identifier of the product variant, unique to the company.

name

string

Name of the product in the commerce platform

isTaxEnabled

boolean

Whether sales taxes are enabled for this product variant.

sku

string

stock keeping unit of the variant.

barcode

integer

Stock keeping unit of the product variant.

weight

object

The product weight

unitPrice

decimal

The price of the product variant

inventory

array

The array of product inventory

isShippingRequired

boolean

createdDate

string
See Date

The Date the Variant was created

Inventory

FieldTypeDescription
totalQuantitydecimalThe total inventory available.
quantityPerLocationarrayThe product quantity per location

Quantity Per Location

FieldTypeDescription
quantitydecimalThe number of inventory available.
locationRefReference TypesLocation details.

Weight

FieldTypeDescription
valuedecimalThe weight of the product.
unitOfMeasurestringUnit of measure used to record the weight of the product.