An (optional) list of barcodes for this product. A barcode should be globally unique and any duplicate barcodes will result in an error.
The (optional) brand of the product. Only has to be specified on the root level of a hierarchy.
The CommodityCode is used for customs declarations and product tariffs. Can be used to store the HS code of the product.
The per-language content of the product.
A small set of default properties has been defined, such as Name and MarketingDescription. Additional content can be defined inside CustomContent
, which is a key-value container
where the key is the name of a property and value should be a single scalar value (string, number, boolean or null) or an array of values.
If LanguageID is left null, this will be the fallback content for languages that have no content of their own. For example, you may offer a French website but you only have English product content, if you specify your English content with LanguageID = null then products on the French website will have the English content.
In general, it's a good idea to choose a language that will serve as the default fallback language and to not specify LanguageID for that language's content so it will function as the fallback content.
The country of origin for the product. Value must conform to the 2-letter country code as defined by ISO 3166-1.
The custom identifier for the product.
In case a type GiftCard product is uploaded, this defines the optional data for configuration.
In case a type GiftCard product is uploaded, this defines if the product is digital, so it will not require a serialnumber during checkout.
In case a type GiftCard product is uploaded, its GiftCardType
is mandatory to connect to its provider.
The unique identifier for the product.
Set to True
to delete the product.
The (optional) ledger class ID of the product. Only has to be specified on the root level of a hierarchy.
Optional field that can be used to store the manufacturer's identifier for this product.
The culture independent name of the product by which it can be recognized even if it otherwise does not have any content. Required unless Type = ContentOnly.
Optional field to indicate a serialnumber will be required when selling this product.
Defines the status of a product.
The TaxCode determines how sales tax applies to this product. This must refer to an existing TaxCode in EVA, if it doesn't exist yet an error is returned.
Required unless Type = ContentOnly.
The string expected here is the Name property of the tax code, so 'High' for TaxCode High.
EVA defines the following default tax codes:
In a hierarchy, the TaxCode only has to be specified for the root level; all products part of the hierarchy will always have the same TaxCode.
Defines what kind of product it is. If the product is part of a hierarchy, this is only relevant for the SKU level, all other levels will have type Configurable.
Defines the per-language value of the variation property for this product. For example, if the variation property is color
then the value could be 'red' or 'blue'.
If the variation value isn't language sensitive then the LanguageID should be left null. If there isn't an item where LanguageID is null, all languages for which this product has content must have a value for the variation property.
Defines the variations hierarchy of the product.
If specified this will add the product to those assortments.