| Name | Description | Type | Additional information |
|---|---|---|---|
| Active |
Active or not |
boolean |
Required |
| BrandId |
Brand id used by the webshop |
integer |
Foreign key field Required |
| CategoryId |
Category id used by the webshop |
integer |
Foreign key field Required |
| ContentType |
Type of content ex. G, L, Kg, ML |
string |
Required Max length: 25 |
| EanCode |
EAN-code of the product |
string |
EAN code Max length: 250 |
| Localizations |
Localizations for the product |
Collection of Oresto.API.Models.POST.Products.Product+Localization |
None. |
| MultiplierAbbreviation |
Information about the multiplier content type ex. L, Kg |
string |
Max length: 25 |
| MultiplierAmount |
Multiplier of the products multiplier content type, for instance a product can be 1 piece (content-type) consisting of 5 KG (multiplier content-type). |
decimal number |
Range: inclusive between 0.0001 and 100000000000000 |
| OnOrder |
Product is only available on order |
boolean |
Required |
| OrderQuantity |
Step size of order. All orders must be a multiple of this. Only available for products with units that support partial amounts (eg: kg). 0 means all amounts are allowed. Defaults to 1. |
decimal number |
Range: inclusive between 0 and 1E+15 |
| ProducerId |
Producer id used by the webshop |
integer |
Foreign key field |
| PromoValidFrom |
Starting date when a promo becomes active (TimeZone BE), if not provided UTC will be used |
date |
Date range: between 1753-01-01 and 9999-12-31 (ISO 8601 format) |
| PromoValidFromUtc |
Starting date when a promo becomes active (TimeZone UTC/GMT) |
date |
Date range: between 1753-01-01 and 9999-12-31 (ISO 8601 format) |
| PromoValidUntil |
Date when the promo should be void (TimeZone BE), if not provided UTC will be used |
date |
Date range: between 1753-01-01 and 9999-12-31 (ISO 8601 format) |
| PromoValidUntilUtc |
Date when the promo should be void (TimeZone UTC/GMT) |
date |
Date range: between 1753-01-01 and 9999-12-31 (ISO 8601 format) |
| SalesPriceList |
The list sales price |
decimal number |
Range: inclusive between 0 and 1E+16 |
| SalesPriceListPromo |
The list sales price during a promotion |
decimal number |
Range: inclusive between 0 and 1E+16 |
| StorageConditionId |
The ID of the storage condition |
integer |
Foreign key field Leave blank for 'other' |
| Supplier |
Supplier information |
Oresto.API.Models.POST.Products.Supplier |
None. |
| TemporarilyUnavailable |
Whether or not the product is temporarily unavailable. If you wish to provide more information about this unavailability, use the field in the property. |
boolean |
None. |
| TemporaryReplacementArticleCode |
Article code of the optional replacement product for a temporarily unavailable product. |
string |
None. |
| TotalContent |
Total content ex. 100 G, 1 KG, 100 ml |
decimal number |
Range: inclusive between 0 and 100000000000000 |
| UnitArticleCode |
In case of a package: the article code of the unit product |
string |
Max length: 50 |
| UnitSalesPriceAbbreviation |
The ID for the unit sales price. ex. kg, L, pc |
string |
Primary key field Required Max length: 25 |
| UnitsPerPackage |
In case of a package: how many units / package |
integer |
None. |
| VatPercentage |
VAT percentage |
integer |
Required |
| WholesalerArticleNumber |
Article code for the product defined by the wholesaler |
string |
Primary key field Required Max length: 50 |
| WholesalerProductLocalizations |
Localizations for the product provided by the wholesaler |
Collection of Oresto.API.Models.POST.Products.Product+WholesalerProductLocalization |
None. |