Product Object

core attributes id string a unique identifier for the product object string the value is always product name string the default product name classification string the tax category of the product created string the date the product was created, formatted as yyyy mm dd hh\ mm\ ss +0 00 utc created unix timestamp the date the product was created as a unix timestamp price price integer the default price of the product in cents currency string appendix docid\ kfbmx4q3dxjtduqf75yx1 the default currency of the product price in stock boolean this attribute shows if the product has any stock available pricetype type string the possible values are physical product , digital product , billing plan , digital service and physical service priceupdated updated string the date the product was last updated, formatted as yyyy mm dd hh\ mm\ ss +0 00 utc updated unix timestamp the date the product was last updated as a unix timestamp buyable boolean this attribute shows if the product is available for sale on sale boolean this attribute shows if there is a specific sale or promotion active currently active price discount allowed boolean this attribute shows if the product can have any discounts applied to it reviews allowed boolean this attribute shows if customers can leave reviews for orders for this item price shown boolean this attribute shows if the product is currently visible in external assets pricedescription description string the default description of the product price seo title string the default seo title of the product price seo description string the default seo description of the product price stock integer the available stock for this product price tax calculation string this attribute shows how taxes are calculated for this product the possible values are exclusive and inclusive price has variations boolean this attribute shows if the product has any variants configured price unlimited stock boolean this attribute shows if the product has unlimited stock applicable for products with type digital service , digita product or billing plan price pricing model array of objects an array of objects, each representing a pricing model associated with the product "pricing model" \[ { "id" "7a2457d5 f219 4332 b63b 4645cd4b80ae", "object" "pricing model", "currency" "eur", "price" 1200, "recommended seller price" 0, "acquisition price" 0 } ] id string the object's unique identifier object string the value is always pricing model currency string appendix docid\ kfbmx4q3dxjtduqf75yx1 the currency of the pricing model price integer the price of the item for this pricing model billing cycle string the billing cycle of this pricing model available for products with type billing plan interval integer the billing interval of this pricing model available for products with type billing plan stripe price id string the id of the stripe price object associated with the product available for products with type billing plan recommended seller price integer the recommended price set by the merchant for the product in this currency available for all product types except billing plan acquisition price integer the base purchase price of the product in this currency available for all product types except billing plan languages object the titles, subtitles, seo descriptions, seo titles and long descriptions of the product in all supported languages the object's keys are a appendix docid\ kfbmx4q3dxjtduqf75yx1 while the values are also objects with the content of the product exampe "languages" { "en" { "title" "blue t shirt", "description" "exclusive blue t shirt, just 100 pieces available", "seo title" "blue t shirt", "seo description" "exclusive blue t shirt, just 100 pieces available", "slug" "blue t shirt" }, "de" { // german content }, "sv" { // swedish content } } variations object you can use variations if you have multiple types of the same product let's say you have a small and medium t shirt but also blue or red; you can create a variation for each example "variations" { "delta pricing" true, "options" \[ { "label" { "en" "size", "de" "größe" }, "values" \[ { "en" "large", "de" "klein" } ], "type" "dropdown list" } ], "variants" \[ { "options" \[ { "size" "large", "sizen" "klein" } ], "stock" 100, "unlimited stock" false, "allow negative stock" false, "hide if no stock" true, "shown" true, "dimensions" { "height" 1, "length" 1, "width" 1 }, "gallery" \[], "sku" "skunumber", "pricing model" \[ { "currency" "eur", "price" 100 } ] } ] } example with stock breakdown (warehouses) "variations" { "delta pricing" true, "options" \[ { "label" { "en" "size", "de" "größe" }, "values" \[ { "en" "large", "de" "klein" } ], "type" "dropdown list" } ], "variants" \[ { "options" { "en" { "size" "large" }, "de" { "größe" "klein" } }, "stock breakdown" \[ 	 { 	 "warehouse" "68f5d2ca 0e90 4ed6 9c08 0f0c597b643d", 	 "stock" 10 	 } 	 ], "weight" 10, "unlimited stock" false, "allow negative stock" false, "hide if no stock" true, "shown" true, "dimensions" { "height" 1, "length" 1, "width" 1 }, "stock" 10, "gallery" \[], "sku" "skunumber", "pricing model" \[ { "currency" "eur", "price" 100, } ] } ] } delta pricing boolean determines how the cost is calculated for all the variants if delta pricing is set to true , the cost is added (or deducted) from the base product price if it is set to false , then the cost is fixed and taken directly from the variant pricing models options array of objects an array of objects, each corresponding to an option such as size or color label object the label of the option in all supported languages it is an object with key value pairs representing a supported language and its corresponding label values array of objects the values of the option such as small , red and large in all supported languages it is an object with key value pairs representing a supported language and its corresponding label type string the option type determines how they are displayed to customers during checkout in tamio sites the possible values are dropdown list and radio buttons variations array of objects an array of objects, each representive an actual product variant gallery array of strings each string in the array is a public image url of the variant shown boolean determines whether the variant is currently visible in external assets allow negative stock boolean this attribute shows whether you can accept orders for this variant if it runs out of stock available for physical products hide if no stock boolean this attribute shows if the variant is visible in external assets such as sites and checkout flows if it runs out of stock available for physical products sku string the variant's sku number available for physical products ean string the variant's ean number available for physical products weight number the weight of the variant available for physical products stock integer the total available stock of the variant pricing model array of objects an array of objects, each representing a pricing model configured on the variant stock breakdown array of objects an array of objects each containing information about the warehouses and stock configuration of the product available for physical products warehouse string the id of the warehouse stock integer the available stock for the product at this warehouse dimensions object an object with the dimensions of the variant available for physical products length number the length of the variant height number the height of the variant width number the width of the variant options object the keys of the object correspond to a supported language the values are also objects with the option configuration in that language secondary attributes additional information object an object contaning additional information about the product such as sku, brand and model "additional information" { "sample" false, "release date unix" null, "release date" null, "expiry date unix" null, "expiry date" null, "new from unix" null, "new from" null, "new to unix" null, "new to" null, "exclude from feed" false, "brand" null, "model" null, "asin" null, "upc" null, "mpn" null, "isbn" null, "ean" null, "gtin" null, "sku" null, "hscode" null } sku string the product's sku number available for products with type physical product mpn string the product's mpn number available for products with type physical product asin string the product's asin number available for products with type physical product ean string the product's ean number available for products with type physical product brand string the product's brand available for products with type physical product model string the model of the product available for products with type physical product isbn string the product's isbn number available for products with type physical product hscode string the product's hs code available for products with type physical product upc string the product's upc number available for products with type physical product gtin string the product's gtin number available for products with type physical product sample boolean this attribute shows if the available stock is sold as a sample exclude from feed boolean this attribute shows if the product is excluded from third party product feeds release date unix timestamp the date the product is released for sale release date string the date the product is released for sale formatted (yyyy mm dd hh\ mm\ ss +0 00 utc) expiry date unix timestamp the expiry date of the product expiry date string the expiry date of the product formatted (yyyy mm dd hh\ mm\ ss +0 00 utc) new from unix timestamp the date that the product is launched as a new item new from string the date that the product is launched as a new item formatted (yyyy mm dd hh\ mm\ ss +0 00 utc) new to unix timestamp the date after which the product will stop being considered a new item new to string the date after which the product will stop being considered a new item formatted (yyyy mm dd hh\ mm\ ss +0 00 utc) max units integer the maximum amount of stock that can be purchased in a single order price min units integer the minimum amount of stock that can be purchased in a single order pricestock limit warning stock limit warning integer if the product stock falls below this value, an email notification will be sent to you price allow negative stock boolean this attribute shows whether you can accept orders for this product if it runs out of stock available for products with type physical product price is moss product boolean legacy legacy this attribute shows if the product's category falls under moss vat rules ( eu merchants ) hide if no stock boolean this attribute shows if the product can be shown in external assets such as sites and checkout flows if it runs out of stock available for products with type physical product weight number the weight of the product available for products with type physical product license type string the possible values are autogenerated , manual or none available for products with type digital product and billing plan license list array of strings an array of strings, each corresponding to a license code available for digital products and billing plans with license type set to manual retries integer the number of retries allowed when the customer fails to pay for their billing plan available for products with type billing plan charge shipping during trial boolean this attribute shows if the shipping cost will be charged during the trial period of a physical subscription cancel action string this attribute shows what action is taken when all available retries for a recurring payment have failed the possible values are pause and cancel it is available for products with the type billing plan cancel behaviour string this attribute shows how manual cancellations are handled when initiated by the customer or the merchant the possible values are immediate and end of period available for products with the type billing plan delivery url string the external delivery url for the digital product available for products with type digital product and delivery type set to url delivery type string this attribute shows how the digital products will be delivered to the customer the possible values are url and file available for products with type digital product descriptor string the statement descriptor of the billing plan billing cycle string the default billing cycle of the billing plan the possible values are month , day , year and week interval integer the default billing interval of the billing plan trial period integer the trial period of the billing plan in days number of downloads integer the number of times a customer can download the digital files associated with this product supported for items with delivery type set to file related products array of strings an array of product ids, each representing a related product digital files array of strings an array of asset ids, each representing a digital file associated with the product whitelist array of strings an array of iso country codes only customers from these countries can purchase this product gallery array of objects each objects in the array contains a public url of an image and its corresponding alt text "gallery" \[ { "public url" "https //pub ox31 com/3003 bqqnwpvd0lfm0d7zo6nmnfg4e/boho earrings 925x 925x618 webp", "alt text" null, "asset id" "12467ac4 7a79 4c24 957b 3fd5f45548ee" } ] dimensions object an object with the dimensions of the product available for products with type physical product "dimensions" \[ { "length" 12, "height" 10, "width" 30 } ] stock breakdown array of objects an array of objects each containing information about the warehouses and stock configuration of the product available for physical products example "stock breakdown" \[ { "warehouse" "some warehouse id", "stock" 10, "areas served" \["de"] }, { "warehouse" "some other warehouse id", "stock" 200, "areas served" \["de"] } ] warehouse string the id of the warehouse stock integer the available stock for the product at this warehouse areas served array of strings an array of country codes or regions served by this warehouse packs array of objects an array of objects each corresponding to a package configured on the product available for products with type physical product example "packs" \[ { "label" "pack of 10", "stock" 10, "multiple" false }, { "label" "pack of 5", "stock" 5, "multiple" false } ] example with variations "packs" \[ { "label" "pack of 10", "stock" 10, "multiple" false, "variants" \[ { "stock" 5, "id" "some variant id" }, { "stock" 5, "id" "some other variant id" } ] } ] label string the label of the package stock integer the total stock contained in this package multiple boolean this attribute shows whether customers can purchase multiples of this pack during checkout variants array of objects an array of objects with the variants contained in this package (if applicable) custom attributes array of objects an array of objects each corresponding to a custom attribute configured on the product "custom attributes" \[ { "id" "1836d6b2 9b95 4c2b a88b ddf51d015b03", "language" "en", "name" "attribute name", "value" "attribute value" } ] id string the id of the custom attribute language string the language of the custom attribute name string this name of the custom attribute value string the value of the custom attribute custom fields array of objects an array of objects each corresponding to a custom field configured on the product "custom fields" \[ { "language" "en", "name" "field name", "type" "checkboxes", "values" \[ "value1", "value2" ] }, { "language" "en", "name" "name", "range from" 1709762400, "range to" 1711749600, "type" "date picker" } ] language string the language of the custom field name string this name of the custom field type string this type of the custom field the possible values are size , checkboxes , textfield , textarea , date picker values array of strings an array of strings, each represtive a value for the custom field available for custom fields with type " checkboxes " range from timestamp the starting range for the custom fields available for custom fields with type " range from " range to string the starting range for the custom fields available for custom fields with type " range to " { "id" "91de2671 199a 459c a50a 2ad126529a56", "object" "product", "name" "my awesome product", "classification" "general", "created" "2022 10 22 23 24 43 +0000", "created unix" 1666481083, "price" 1200, "currency" "eur", "gallery" \[], "in stock" true, "type" "physical product", "updated" "2022 10 22 23 38 04 +0000", "updated unix" 1666481884, "on sale" true, "buyable" false, "discount allowed" true, "hide if no stock" true, "reviews allowed" true, "shown" true, "description" null, "seo description" null, "seo title" null, "stock" 10, "tax calculation" "exclusive", "has variations" true, "unlimited stock" false, "pricing model" \[ { "id" "7a2457d5 f219 4332 b63b 4645cd4b80ae", "object" "pricing model", "currency" "eur", "price" 1200, "recommended seller price" 0, "acquisition price" 0 } ], "custom attributes" null, "min units" null, "max units" null, "stock limit warning" null, "allow negative stock" false, "additional information" { "sample" false, "release date unix" null, "release date" null, "expiry date unix" null, "expiry date" null, "new from unix" null, "new from" null, "new to unix" null, "new to" null, "exclude from feed" false, "brand" null, "model" null, "asin" null, "upc" null, "mpn" null, "isbn" null, "ean" null, "gtin" null, "sku" null, "hscode" null }, "languages" { "en" { "title" "my awesome product", "seo title" null, "description" null, "seo description" null, "slug" null } }, "packs" \[ { "id" "1ec6e373 378c 4655 9d35 23056d753558", "label" "pack of 10", "multiples" false, "stock" 10, "variants" \[ { "id" "854e9ede 4e47 4838 924f 8dce1f80b2d8", "stock" 10 } ] } ], "related products" null, "weight" null, "dimensions" { "length" null, "width" null, "height" null }, "variations" { "delta pricing" true, "options" \[ { "label" { "de" "größe", "en" "size" }, "type" "dropdown list", "values" \[ { "de" "klein", "en" "large" } ] } ], "variants" \[ { "allow negative stock" false, "dimensions" { "height" 1, "length" 1, "width" 1 }, "gallery" \[], "hide if no stock" true, "id" "854e9ede 4e47 4838 924f 8dce1f80b2d8", "options" { "en" { "size" "large" }, "de" { "größe" "klein" } }, "pricing model" \[ { "id" "78805515 8c2b 4fef b79a 4fe81cd021f2", "object" "pricing model", "currency" "eur", "price" 10000, "recommended seller price" 0, "acquisition price" 0 } ], "shown" true, "sku" "skunumber", "stock" 10, "stock breakdown" \[ { "areas served" \[ "au", "ar" ], "stock" 10, "warehouse" "68f5d2ca 0e90 4ed6 9c08 0f0c597b643d" } ], "unlimited stock" false } ] }, "is moss product" false }