Catalog Format (v3)

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 format can be used for a manual upload or an automated SFTP import.

v3 remains supported for existing integrations. Use the format already configured for your integration.

Required data

Each product requires a Product ID, Product name and category information according to the format configured for the existing integration. This legacy format is not intended for new integrations.

Column order

The v3 format defines 15 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 and bundle type empty for products supplied only as a single vessel or by weight.

Columns

  1. Category name: The name of the product category
  2. Category ID: A unique category identifier (optional)
  3. Product ID: The unique product identifier
  4. Product name: The product name
  5. Order by: One of "vessel" or "kg" (defaults to "vessel")
  6. Vessel size: The size of the product vessel in the specified unit
  7. Vessel unit: One of "l", "dl", "cl", "ml", "kg", "g" or "quantity"
  8. Vessel type: See vessel and bundle types (optional) [1]
  9. Bundle size: The number of vessels in the bundle
  10. Bundle type: See vessel and bundle types
  11. Price: The unit price, e.g. 1234.56 (optional)
  12. Price per: One of "vessel", "l", "kg" or "100g" (defaults to "vessel")
  13. Minimum order count: The minimum number of units to order (optional)
  14. Status: One of "ACTIVE", "INACTIVE" or "OUT_OF_STOCK" (defaults to "ACTIVE") [2]
  15. Image: The original URL of the image where it can be downloaded from (optional) [1:1]

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.


  1. Introduced in v3 (2023-01-17) ↩︎ ↩︎

  2. Introduced in v2 (2022-12-08) ↩︎