YBM Connect | Documentation

Catalog Format (v5)

Use this catalog format to keep your product catalog in sync with YBM Connect. It provides a structured way to exchange product details, bundles, prices and supporting data. The same format can be used for a manual upload in YBM Connect or for an automated SFTP import.

Template
Example

Column order

The v5 format defines 50 columns. Include every column and keep the column order unchanged. Optional values may be empty, but their columns must remain in the file. Include a header row for people who work with the file, but do not rely on its labels for validation: values are mapped by their position.

Use consecutive rows with the same Product ID for multiple bundles. All values other than the bundle fields must be identical on these rows.

Bundle fields are only needed when a product is supplied in a bundle. Leave the bundle size, bundle type, bundle GTIN and bundle deposit price empty for products supplied only as a single vessel or by weight.

Columns

The core columns are listed below. All columns must remain in this exact order.

Column Required Format Example Notes
Category name Yes Text Gemüse Category name.
Category ID No ID 100 Optional category identifier.
Product ID Yes ID 123456 Stable product identifier.
Product name Yes Text Cherrytomaten Bio 250 g Name shown for the product. Max. 64 characters.
Order by Yes vessel or kg vessel vessel for units, kg for weight.
Vessel size Depends Number 250 Required when Order by is vessel.
Vessel unit Depends l, dl, cl, ml, kg, g or quantity g Required when Order by is vessel.
Vessel type No Vessel type BG Optional packaging type.
Bundle size No Whole number ≥ 2 8 Number of units in the bundle.
Bundle type No Bundle type carton Optional bundle type. Defaults to NA.
Bundle GTIN No EAN/GTIN GTIN of the bundle.
Bundle deposit price No Non-negative decimal number Deposit per bundle.
Price No Non-negative decimal number 3.90 Stored with 2 decimal places.
Price per No vessel, l, kg or 100g vessel Defaults to vessel.
Deposit price No Non-negative decimal number Deposit for the base unit.
Minimum order count No Number 1 Minimum order quantity.
Status No ACTIVE
INACTIVE
OUT_OF_STOCK		 ACTIVE Defaults to ACTIVE.

The following optional columns may be left empty, but their columns must remain in the file. Only fill in a column when it applies to the product:

  1. Image: The original URL of the image where we can download it from
  2. GTIN: EAN or GTIN code associated with the product
  3. Labels: Comma-separated list of labels. Accepted values: "NEW", "BIO", "SEASONAL", "DISCOUNTED", "VEGAN", "VEGETARIAN" and "GLUTEN_FREE".
  4. Description: Product description
  5. Manufacturer: The name of the manufacturer
  6. Brand: Product brand
  7. Region: The region the product is from
  8. Country: ISO country code of the product
  9. Vintage: Year of production or harvest
  10. Ingredients: Description of the ingredients
  11. Allergens: List of allergens in the product
  12. Trace allergens: Comma-separated trace allergens, e.g. gluten, nuts
  13. Storage advice: Description of the best way to store the product
  14. Nutritional values: Nutritional information for the product
  15. Dietary labels: Comma-separated labels. They are combined with Labels; use only the accepted values listed for Labels above.
  16. Alcohol content: Percentage of alcohol in the product without the percentage sign, e.g. "40" or "12.5"
  17. Color: Product color
  18. Grape variety: Type of grape used for making the wine
  19. Wine-making: The process used to make the wine
  20. Material: Materials present in the finished product
  21. Fishing method: The method used to catch the fish
  22. Length: The length of the product
  23. Width: The width of the product
  24. Height: The height of the product
  25. Diameter: The diameter of the product
  26. Dry weight: Dry weight as a whole number, e.g. 1200
  27. Net weight: Weight of the product without packaging
  28. Total weight: Total weight of the product as shipped
  29. VAT: The VAT rate for the product
  30. External URL: URL of a product sheet or detail page
  31. Name FR: The product name in French
  32. Name IT: The product name in Italian
  33. Name EN: The product name in English

Value handling

  • Deposit prices are converted to the internal currency subunit. For example, 2.35 becomes 235.
  • Price, Deposit price and Bundle deposit price use ordinary currency values such as 12.50; YBM Connect stores them internally as the smallest currency unit.
  • Empty deposit prices remain empty.
  • Prices and deposits may use a comma or a decimal point. Values are rounded to the nearest cent internally.
  • Trace allergens are stored as a comma-separated list after trimming empty values.
  • Dry weight must be a whole number. Invalid values such as 1.2kg are not imported.
  • Invalid bundle sizes are ignored. A missing bundle type is stored as NA.
  • Invalid optional values such as an invalid country code, year or weight may be left empty while the remaining product data is imported. Review the import result carefully if optional values are provided.

Read the catalog upload and validation guide before your first manual or automated import.

Custom Format

You cannot provide your product catalog in the above format? Please get in touch, we might be able to help.

Existing integrations

YBM Connect accepts v5 for manual uploads and automated SFTP imports. Existing integrations using v4 or v3 can continue using their configured format and its documentation.