| Name | Description | Type | Additional information |
|---|---|---|---|
| Active |
Whether or not the product is visible in the webshop. A product being inactive is NOT the same as the product being deleted. Inactive products can become active. |
boolean |
None. |
| AmountOfUnitProduct |
In case of packaging: amount of single units in a package |
integer |
None. |
| Brand |
Information about the brand |
Oresto.API.Models.GET.Products.Brand |
None. |
| Categories |
List of categories in which the product is located |
Collection of Oresto.API.Models.GET.Products.Category |
Required |
| ContentType |
Information about the content type |
Oresto.API.Models.GET.Products.ContentType |
None. |
| EanCode |
EAN-code of the product |
string |
EAN code Max length: 250 |
| Id |
The ID of the product |
integer |
None. |
| IsPackageProduct |
Is a packaging product |
boolean |
Required |
| LastModified |
The date the product was last modified (TimeZone BE) |
date |
Required |
| LastModifiedUtc |
The date the product was last modified (TimeZone UTC/GMT) |
date |
Required |
| Localizations |
Localizations for the product |
Collection of Oresto.API.Models.GET.Products.Product+Localization |
Required |
| 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 |
| MultiplierContentType |
Information about the multiplier content type |
Oresto.API.Models.GET.Products.ContentType |
None. |
| 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 |
| PackageProducts |
Link information about the packaging product (unique) with multiple possible unit sales types |
Collection of Oresto.API.Models.GET.Products.LinkedProduct |
None. |
| Producer |
Information about the producer |
Oresto.API.Models.GET.Products.Producer |
None. |
| PromoValidFrom |
Starting date when a promo becomes active (TimeZone BE), if not provided UTC will be used |
date |
None. |
| PromoValidFromUtc |
Starting date when a promo becomes active (TimeZone UTC/GMT) |
date |
None. |
| PromoValidUntil |
Date when the promo should be void (TimeZone BE), if not provided UTC will be used |
date |
None. |
| PromoValidUntilUtc |
Date when the promo should be void (TimeZone UTC/GMT) |
date |
None. |
| 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 |
| StorageCondition |
Information about the storage condition |
Oresto.API.Models.GET.Products.StorageCondition |
Required |
| Suppliers |
List of possible suppliers |
Collection of Oresto.API.Models.GET.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 1E+16 |
| UnitProducts |
Link information about the unit product (unique) with multiple possible unit sales types |
Collection of Oresto.API.Models.GET.Products.LinkedProduct |
None. |
| UnitSalesPrice |
Information about the unit sales price |
Oresto.API.Models.GET.Products.ContentType |
Required |
| UnitsPerPackage |
Same value as AmountOfUnitProduct, duplicated as UnitsPerPackage to match the naming used in other parts of the API. |
integer |
None. |
| VatPercentage |
VAT percentage |
integer |
None. |
| 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.GET.Products.Product+WholesalerProductLocalization |
None. |