Commerce Product

By default, the Commerce Product's history is 12 months.

Field	Type	Description
id	uuid	Unique identifier (UUID)
category	string	Categorization of product.
name	string	Title of location.
description	string	Description of location.
images	array of strings	Array of image urls.
status	string	Product status - Possible values : UNKNOWN PUBLISHED UNPUBLISHED
url	string	The URL to access this product on platform's site.
variants	array of CommerceProductVariant	Array of Product Variants
tags	array of strings	Store tags for the product.
source_created_at	datetime	Date on which the product was created (as given by the source provider).
source_updated_at	datetime	Date on which the product was updated (as given by the source provider).
provider_name	string	Name of the provider the data is coming from (informational field) - e.g. "Paypal", "Stripe", ...
data_connection_id	uuid	UUID of the data connection leading to this data

CommerceProductVariant object

Field	Type	Description
id	uuid	UUID of the Product Variant
product_id	uuid	UUID of the parent Product
barcode	string	Unique product number of the variant (barcode, UPC, ISBN, ...)
name	string	Name of the product recorded in the platform
price	Money	Price of variant
sku	string	Stock-keeping unit number
fulfillment_service	string	Name of fulfillment service
requires_shipping	bool	Whether or not the product requires delivery
inventory	CommerceProductInventory	Information about the total inventory as well as the locations inventory is in
weight	Weight	Weight of this variant
source_created_at	datetime	Date on which the product variant was created (as given by the source provider).

CommerceProductInventory object

Field	Type	Description
total_quantity	integer	The total inventory across all locations
locations	array of CommerceProductInventoryLocation	Details of the locations of each quantity of the inventory

CommerceProductInventoryLocation object

Field	Type	Description
quantity	integer	The quantity of inventory at this location
location_id	uuid	UUID of the Location