The product object
Product
Parameter | Data type | Default | Description |
---|---|---|---|
item_number | string | The item number of product. This is unique accross your account | |
name | string | The name for this product | |
description | string | null | A long description for this product |
subbrand_id | int | null | Subbrand of the product |
collection_id | int | null | Collection of the product |
meta | object | {} | An object with {"key": "value"} with custom meta data of the product. This is used for storing custom fields |
created_at | datetime | ||
updated_at | datetime | ||
categories.* | If eager loaded | An array of object category | |
variants.* | If eager loaded | An array of object variant |
Variant
Parameter | Data type | Default | Description |
---|---|---|---|
sku | string | The SKU of the variant. This is unique accross your account | |
attributes | object | An object with {"key": "value"} with the attributes of the variant. This will be Colors, Sizes, etc. | |
ean | string | null | The barcode for this variant |
meta | object | {} | An object with {"key": "value"} with custom meta data of the variant. This is used for storing custom fields |
prices | object | {} | An object of prices for the product. Prices should be keyed by their currency code |
created_at | Yes | ||
updated_at | Yes |
Prices
note
Prices should be keyed by their currency code. E.g.
{
"DKK": {
"sales_price": 100
},
"EUR": {
"sales_price": 10
}
}
This would add a DKK price and a EUR price to the variant.
Parameter | Data type | Default | Description |
---|---|---|---|
sales_price | float | 0 | The wholesale (WHS) price of the variant. This price is used for B2B orders |
rec_sales_price | float | 0 | The rec retail price (RRP) of the variant. This price is used for B2C orders. This price is also used for B2C integrations like Shopify and Woocommerce. |
offer_price | float | null | A special temporary offer price for B2B orders. When this price is not null it means that it should be used instead of sales_price . Also the B2B shop in Traede will show the percentage difference between sales_price and offer_price as "savings" when buying the product. Use this property to put a variant "on sale" for B2B orders |
b2c_offer_price | float | null | A special temporary offer price for B2C orders. When this price is not null it means that it should be used instead of rec_sales_price . We will also use this property to put the variant "on sale" in B2C systems like Shopify and Woocommerce. Use this property to put a variant "on sale" for B2C orders |