Feed XML specification
This guide contains the following:
Transfer of products to the Pepita.hu system
The submitted product list must comply with the following rules:
- The XML product list encoding can only be
UTF-8
- The prices are required, price 0 is not accepted by our system
- Appropriate XML encoding of special characters is required (using &, >, < instead of „&, <, >” characters)
- For URLs: please make sure the URL contains only standard characters (for example: „+” instead of „space” or %20 characters)
The structure of the XML file and the fields to be included are shown in the following table:
Element | Required? | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
<Id> |
Required |
The unique identifier of the product. It’s a text value that:
|
||||||||||||
<LastMod> |
Optional | Date of last modification of the product. Its format is a numeric value (timestamp), for example: 1583996473 (This corresponds to 2020-03-12 07:01:13). | ||||||||||||
<StructuredId> |
Recommended | Product UPC/EAN/ISBN code provided by the manufacturer for the product. If available, it is strongly recommended to provide the for faster and more efficient processing. | ||||||||||||
<ProductNumber> |
Recommended | Product code provided by the manufacturer (MPN - Manufacturer Part Number) | ||||||||||||
<Descriptions> |
Required | |||||||||||||
├── <Name> |
Required | The name of the product. | ||||||||||||
├── <Description> |
Required | The (long) description of the product. | ||||||||||||
├── <Brand> |
Optional | The brand of the product. | ||||||||||||
├── <Manufacturer> |
Optional | The name of the product’s manufacturer. | ||||||||||||
├── <Author> |
Optional | In the case of a book-type product, the name of the author of the book. | ||||||||||||
├── <Publisher> |
Optional | In the case of a book-type product, the name of the publisher of the book. | ||||||||||||
<Prices> |
Required | |||||||||||||
├── <Currency> |
Required |
ISO 4217 code for the currency of the product. (for example: HUF in case of Ft)
|
||||||||||||
├── <Price> |
Required |
The price of the product (in the currency specified in the <Currency> tag).
|
||||||||||||
├── <DiscountedPrice> |
Optional |
In case of a discounted product, the discounted price of the product (in the currency specified in the <Currency> tag).
|
||||||||||||
├── <PurchaseNetPrice> |
Optional |
Net delivery price of the product (in the currency specified in the <Currency> tag).
|
||||||||||||
├── <ShippingPrice> |
Optional |
The shipping cost of the product if it differs from the default shipping cost (in the currency specified in the <Currency> tag).
|
||||||||||||
<Warranty> |
Optional | Garanciainformációkat tartalmaz a termékről | ||||||||||||
├── <Type> |
Optional |
If the product is warranted, it includes the type of warranty period. Possible values:
|
||||||||||||
├── <Duration> |
Optional | The length of the warranty period. | ||||||||||||
<Categories> |
Required | What categories does the product belong to, from the highest category to the lowest. (e.g. Books> Baby Diary). Contains one or more <Category> elements. |
||||||||||||
├── <Category> |
Required | Describes one of the category of the product | ||||||||||||
├── <Id> |
Optional | Unique category identifier in your own store's register | ||||||||||||
├── <Name> |
Required | Category name. | ||||||||||||
<Photos> |
Required | What images are included with the product; contains one or more <Photo> elements. |
||||||||||||
├── <Photo> |
Required | Describes one of the photo of the product. | ||||||||||||
├── <Url> |
Required | The full URL of the image. | ||||||||||||
├── <IsPrimary> |
Required | Is this image the primary/default image of the product? (can be true vagy false ) |
||||||||||||
├── <Title> |
Optional | The title of the image | ||||||||||||
├── <PrimaryVariation> |
Optional | If the image belongs to a version of the product, the value of the primary property (the value of the property specified in the PrimaryAttribute field) |
||||||||||||
├── <SecondaryVariation> |
Optional | If the image belongs to a version of the product, the value of the secondary property (the value of the property specified in the SecondaryAttribute field) |
||||||||||||
├── <TertiaryVariation> |
Optional | If the image belongs to a version of the product, the value of the tertiary property (the value of the property specified in the TertiaryAttribute field) |
||||||||||||
<VideoLinks> |
Optional | Videos included with the product. The full URL of one or more videos, separated by commas | ||||||||||||
<ProductUrl> |
Optional | The full URL of the product. | ||||||||||||
<Availability> |
Required | It contains stock informations about the product. | ||||||||||||
├── <Available> |
Required | Is the product in stock (can be true vagy false ) |
||||||||||||
├── <Quantity> |
Optional | How many products are currently in stock. | ||||||||||||
├── <RestockDate> |
Optional | When is the next stock replenishment expected? (YYYY-MM-DD date format) |
||||||||||||
├── <ShippingDelay> |
Optional | Expected delivery time (in days). | ||||||||||||
<Attributes> |
Optional | Field to specify product characteristics. It’s worthwhile to provide as many product features as possible, because the product will be more searchable in the system for the customers. | ||||||||||||
├── <Attribute> |
Required | Allows you to specify a specific product feature, any number of attributes can be sent in the feed. | ||||||||||||
├── <AttributeName> |
Required | Specific name of the product characteristic. For example: Memory (GB) | ||||||||||||
├── <AttributeValue> |
Required | The value of the product characteristic, e.g. staying with the previous ’Memory’ example: 16 | ||||||||||||
<VolumeDimensions> |
Optional | Field for entering product volume data and weight (Width, Length, Height, Weight). | ||||||||||||
├── <Width> |
Optional | The width of the product in cm. Correct formats: "15"; "0.5"; "0.68"; | ||||||||||||
├── <Height> |
Optional | The height of the product in cm. Correct formats: "15"; "0.5"; "0.68"; | ||||||||||||
├── <Length> |
Optional | The length of the product in cm. Correct formats: "15"; "0.5"; "0.68"; | ||||||||||||
├── <Weight> |
Optional | Product weight in kg. Correct formats: "15"; "0.5"; "0.68"; "0.0001"; |
For variation products, the structure of the XML file is supplemented as follows:
Element | Required? | Description |
---|---|---|
<Variations> |
Optional | What variations belong to the product. |
├── <PrimaryAttribute> |
Required | It’s specifies the property by which the variations are distinguished. (for example: if a stroller is available in 3 colors, the primary attribute will be the color) |
├── <SecondaryAttribute> |
Optional | If we can distinguish product variations based on two properties, you can specify the second property. (for example: if a T-shirt is available in several colors and sizes) |
├── <TertiaryAttribute> |
Optional | If we can distinguish product variations based on three properties, you can specify the third property. |
├── <Variation> |
Required | Describes a version of the product. |
├── <PrimaryVariation> |
Required | Primary property value (the value of the property specified in the PrimaryAttribute field) |
├── <SecondaryVariation> |
Optional | Secondary property value (the value of the property specified in the SecondaryAttribute field) |
├── <TertiaryVariation> |
Optional | Tertiary property value (the value of the property specified in the TertiaryAttribute field) |
├── <Prices> |
Optional | If the product have different versions with different prices, it can be entered here. |
├── <Currency> |
Required |
ISO 4217 code for the currency of the products. (for example: HUF in case of Ft)
|
├── <Price> |
Required |
The price of the variation product (in the currency specified the <Currency> tag).
|
├── <DiscountedPrice> |
Optional |
In case of a discounted product, the discounted price of the variation product (in the currency specified in the <Currency> tag).
|
├── <ShippingPrice> |
Optional |
The shipping cost of the variation product if it differs from the default shipping cost (in the currency specified in the <Currency> tag).
|
├──<Availability> |
Required | It contains stock information for the product version. |
├── <Available> |
Required | Is the product version in stock? (true vagy false ) |
├── <Quantity> |
Optional | How many products are currently in stock. |
├── <RestockDate> |
Optional | When is the next stock replenishment expected? (YYYY-MM-DD date format) |
├── <ShippingDelay> |
Optional | Expected delivery time (in days) |
Sample XML
Download example XMLTransfer of stock to the Pepita.hu system
The structure of the stock XML file and the fields to be included are shown in the following table:
Element | Required? | Description |
---|---|---|
<Id> |
Required |
The unique identifier of the product. It’s a text value that:
|
<Availability> |
Required | It contains stock informations about the product. |
├── <Available> |
Required | Is the product in stock (can be true vagy false ) |
├── <Quantity> |
Optional | How many products are currently in stock. |
For variation products, the structure of the stock XML file is supplemented as follows:
Element | Required? | Description |
---|---|---|
<Variations> |
Optional | What variations belong to the product. |
├── <PrimaryAttribute> |
Required | It’s specifies the property by which the variations are distinguished. (for example: if a stroller is available in 3 colors, the primary attribute will be the color) |
├── <SecondaryAttribute> |
Optional | If we can distinguish product variations based on two properties, you can specify the second property. (for example: if a T-shirt is available in several colors and sizes) |
├── <TertiaryAttribute> |
Optional | If we can distinguish product variations based on three properties, you can specify the third property. |
├── <Variation> |
Required | Describes a version of the product. |
├── <PrimaryVariation> |
Required | Primary property value (the value of the property specified in the PrimaryAttribute field) |
├── <SecondaryVariation> |
Optional | Secondary property value (the value of the property specified in the SecondaryAttribute field) |
├── <TertiaryVariation> |
Optional | Tertiary property value (the value of the property specified in the TertiaryAttribute field) |
├──<Availability> |
Required | It contains stock information for the product version. |
├── <Available> |
Required | Is the product version in stock? (true vagy false ) |
├── <Quantity> |
Optional | Expected delivery time (in days) |