Skip to content

Products Object



id
string
REQUIRED · 

The unique identifier for a product

name
string

The name of a product

description
string

The description of a product

status
string

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

All possible enum values:
  • active
  • inactive
price
string

The price of a product

sku
string

The sku of a product

inventory_quantity
string

The quantity of a product in stock

images
object[]

The images of a product

id
string

The unique identifier of an image of a product

url
string

The url of an image of product

weight
string

The weight of a product

weight_unit
string

The weight unit of a product

options
object[]

The options of a product

id
string

The unique identifier of an option of a product

name
string

The name of option for product

values
array

The values of option for product

variants
object[]

The options of a product

id
string

The unique identifier of a variant of a product

name
string

The name of variant for product

price
string

The price of variant for product

sku
string

The sku of variant for product

inventory_quantity
string

The quantity of variant for product in stock

weight
string

The weight of variant

options
object[]

The options for variant

id
string

The unique identifier for option of variant

name
string

The name for option of variant

value
string

The value for option of variant

images
object[]

The images for variant

id
string

The unique identifier for image of variant

url
string

The url of image of variant

tags
string[]

The tags of a product

categories
object[]

The categories of a product

id
string

The unique identifier of a category of product

name
string

The name of category for product

created_at
string · date-time

The date and time when product was created

updated_at
string · date-time

The date and time when product was updated

remote_data
object

Raw data returned from the remote API call.