YOM Docs

• Integration guides
  • Integration methods
    • API integration
    • File integration
  • Entities
    • Categories
    • Distribution Center
    • Commerces
    • Loaned Equipment
    • Delivery cost
    • Credit
    • Tax Documents
    • Discount limit
    • Payments
    • Products
    • Promotions
    • Segments
    • Overrides
    • Stock
    • Supervisors
    • Transactions
    • Sellers
  • Webhooks
    • Technical requirements
    • Customer-to-YOM Webhooks
      • Order modification
      • Bulk stock upload
      • Bulk order modification
    • YOM-to-customer Webhooks
      • Orders
      • Payments
      • Minimum order
      • Delivery price
      • Returns
      • Loaned Equipment
      • Commerce creation
  • Changelog
  • Recommendations Extraction API
    • Authentication
    • Recommendations
    • Best practices
• Settings

2026 October 05 → 2.0.0

The documentation has been reorganized. Retired pages are no longer available; their content now lives in the new sections.

New structure

• Added Integration methods, which brings together the two ways to send data to YOM:
  • API integration: merges the former pages Scheduled API, Technical requirements, Endpoints to make available and Implementation.
  • File integration: merges the former pages Files (Data upload), Intelligence, Operational, Files to make available and Implementation, and includes the folder structure, the file name for each entity, and the CSV format.
• Added Entities, with the data model for each entity. The model is the same for API integration and file integration.
• Removed the per-file entity pages (Commerces, Products, Transactions, Sellers, Categories, Stock, and others), whose content was already documented under each entity.

Entities

• Each entity indicates, next to its endpoint, the file name used for file integration (<fecha>_<hora>_<entidad>.csv).
• Added the endpoint GET /api/promotion to Promotions.

Webhooks

• Commerce creation is now YOM-to-customer Webhooks and has been rewritten to match the current contract: a commerceRequest body with the form responses, approved, rejected, observations and pending statuses, a commerceData object to create the commerce, a maximum response time of 70 seconds, and no automatic retries. Periodic status polling via GET is removed.

Navigation

• The side menu is shown expanded on every page.
• Every page includes Previous steps and Next steps links, in menu order.
• Column widths adjusted to give the content more room.

2024 December 19 → 1.4.1

Updated the Category entity.

The categoryKey and parentCategoryKey fields are replaced by categoryId and parentCategoryId to follow the convention used by the other entities → Categories

2024 December 18 → 1.4.0

Updated data injection via Webhooks. Added injection of Orders and Payments. → Webhooks

2024 December 13 → 1.3.0

Updated the Commerce entity.

• Added the locations field, which lists the physical locations of the Commerce → Commerces. It replaces the location field.
• Sellers,Supervisors
• Deprecated the use of the administrativeLevel and logisticalLevel fields.

Updated the Product entity.

• Deprecated the use of measurement and packaging. Replaced by the use of formats and constraints → Products

Updated the Override entity.

• Added the ability to override the constraints field of a Product through an Override.

2024 December 12 → 1.2.0

• Updated the Promotions entity. Added an explanation of its types, goals, and the logic of Promotion Rules → Promotions

2024 December 06 → 1.1.0

• Updated the Payments entity to support multiple documents, details, and recording of external transactions → Payments

2024 December 05 → 1.0.5

• Added a filter on the date field as required for Scheduled API integration of Transactions.

2024 November 27 → 1.0.4

• Fixed examples for the Product entity. ****They include the change from sku to productId introduced in version 1.0.2.

2024 September 24 → 1.0.3

• Defined ; as the default separator for file data upload → File integration

2024 July 19 → 1.0.2

• Defined the location field of Commerce.
• Defined the dimensions, measurement, packaging and formats fields of Product as options for handling sales formats.
• Replaced the use of sku with productId in Product. We recommend using the SKU as the unique identifier for the Product, but you can use a different identifier.

2024 July 03 → 1.0.1

• Unified references to Commerces across all entities. ****The words user and client in all their variants are replaced by commerce. This covers the fields:

2024 July 01 → 1.0.0

• Initial version published