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 integer
The default price of the product in cents.
﻿
currency string Currency Code﻿
The default currency of the product.
﻿
in_stock boolean
This attribute shows if the product has any stock available.
﻿
type string
The possible values are physical_product, digital_product, billing_plan, digital_service and physical_service.
﻿
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.
﻿
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.
﻿
shown boolean
This attribute shows if the product is currently visible in external assets.
﻿
description string
The default description of the product.
﻿
seo_title string
The default SEO title of the product.
﻿
seo_description string
The default SEO description of the product.
﻿
stock integer
The available stock for this product.
﻿
tax_calculation string
This attribute shows how taxes are calculated for this product. The possible values are exclusive and inclusive. 
﻿
has_variations boolean
This attribute shows if the product has any variants configured.
﻿
unlimited_stock boolean
This attribute shows if the product has unlimited stock. Applicable for products with type digital_service, digita_product or billing_plan. 
﻿
pricing_model array of objects
An array of objects, each representing a pricing model associated with the product. 
JSON
"pricing_model": [
    {
      "id": "7a2457d5-f219-4332-b63b-4645cd4b80ae",
      "object": "pricing_model",
      "currency": "EUR",
      "price": 1200,
      "recommended_seller_price": 0,
      "acquisition_price": 0
    }
]
"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 Currency Code﻿
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 Language Codes﻿ 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
    }
}
"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
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": [
               {
                   "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
                }
            ]
        }
    ]
}

"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
                }
            ]
        }
    ]
}
﻿
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-listand 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.
JSON
"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
}
"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.
﻿
min_units integer
The minimum amount of stock that can be purchased in a single order.
﻿
stock_limit_warning integer
If the product stock falls below this value, an email notification will be sent to you.
﻿
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
﻿
is_moss_product boolean 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.
JSON
"gallery": [
  {
    "public_url": "https://pub.ox31.com/3003-bQqNWPvD0lFm0D7zo6NmNFG4E/boho-earrings_925x_925x618.webp",
    "alt_text": null,
    "asset_id": "12467ac4-7a79-4c24-957b-3fd5f45548ee"
  }
]
"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
JSON
"dimensions": [
  {
    "length": 12,
    "height": 10,
    "width": 30
  }
]
"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"]
    }
]
"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
Example with Variations
"packs": [
  {
    "label": "Pack of 10",
    "stock": 10,
    "multiple": false
  },
  {
    "label": "Pack of 5",
    "stock": 5,
    "multiple": false
  }
]
"packs": [
  {
    "label": "Pack of 10",
    "stock": 10,
    "multiple": false
  },
  {
    "label": "Pack of 5",
    "stock": 5,
    "multiple": false
  }
]
﻿
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. 
JSON
"custom_attributes": [
  {
    "id": "1836d6b2-9b95-4c2b-a88b-ddf51d015b03",
    "language": "en",
    "name": "Attribute name",
    "value": "Attribute value"
  }
]
"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. 
JSON
"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"
  }
]
"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".
﻿
﻿
/
Product Object Example
View
﻿
﻿
Products
Create Physical Product