Skip to content

Properties

idstring
required·

The unique identifier for a product

categoriesobject[]

The categories of a product

idstring

The unique identifier of a category of product

namestring

The name of category for product

created_atstring · date-time

The date and time when product was created

descriptionstring

The description of a product

imagesobject[]

The images of a product

idstring

The unique identifier of an image of a product

urlstring

The url of an image of product

inventory_quantitystring

The quantity of a product in stock

namestring

The name of a product

notesstring

The notes related to the product, if any.

optionsobject[]

The options of a product

idstring

The unique identifier of an option of a product

namestring

The name of option for product

valuesarray

The values of option for product

pricestring

The price of a product

remote_dataRecord<string, any>

Raw data returned from the remote API call.

skustring

The sku of a product

statusstring

The status of a product. If no clear mapping exists, then raw value is returned.

Possible values:
activeinactive
tagsstring[]

The tags of a product

updated_atstring · date-time

The date and time when product was updated

variantsobject[]

The options of a product

idstring

The unique identifier of a variant of a product

imagesobject[]

The images for variant

2 properties
idstring

The unique identifier for image of variant

urlstring

The url of image of variant

inventory_quantitystring

The quantity of variant for product in stock

namestring

The name of variant for product

optionsobject[]

The options for variant

3 properties
idstring

The unique identifier for option of variant

namestring

The name for option of variant

valuestring

The value for option of variant

pricestring

The price of variant for product

skustring

The sku of variant for product

weightstring

The weight of variant

weightstring

The weight of a product

weight_unitstring

The weight unit of a product