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

Products

After registering your commerces, it is time to upload your products.

What are my products? Products in YOM are each of the items you offer for sale to your customers, commercially identified by their SKU.

These products are represented by the Product entity. A Product contains specific attributes that make it unique, such as its identifier, name, price, and categorization within specific groups. It is important to distinguish productId from sku: the productId is the unique identifier that YOM uses to reference each product in the integration, while the sku is the commercial code the business uses to identify the item. The two values may match, but they are distinct fields. The platform lets you manage the activation, featuring, and availability of each product.

Endpoint

The Products endpoint provides access to detailed information about each product registered in YOM.

GET /api/products

FILE <fecha>_<hora>_product.csv

Fields

The following table defines the base integration model for the Product entity. This model is the base contract and is extensible: it can be supplemented with additional attributes through the otherProperties object, as described in the Additional attributes section.

Product

{
  "key": "Tipo de Grano",
  "value": "Trigo"
}

], "parentSku": "HARINA-MINIMA-SKU001", "genericDisplayName": "Harina Básica de Trigo", "index": 0 }| |otherProperties| 📝 Object | ⚪️ Optional | Key-value object with additional attributes of the **Product**. See the **Additional attributes** section. |{"family": "Abarrotes", "line": "Panificación"}| |appHidden| 🔘 Bool | ⚪️ Optional | Flag that controls whether the product is shown in the app |false| |b2bHidden| 🔘 Bool | ⚪️ Optional | Flag that controls whether the product is shown in the b2b |false` |

Dimensions

The dimensions structure in the Product object lets you define the physical dimensions of the product, including weight, volume, and measurements.

| --- | --- | --- | --- | --- |

Example

"dimensions": {
    "weight": 1.5,
    "weightUnit": "kg",
    "length": 30,
    "lengthUnit": "cm",
    "width": 20,
    "widthUnit": "cm",
    "height": 15,
    "heightUnit": "cm",
    "volume": 9,
    "volumeUnit": "L"
}

Constraint

The constraints structure in the Product object lets you define the purchase constraints associated with the Product for B2B sales. This object groups the rules that determine both the minimum number of units that can be purchased and the allowed increments when placing an order.

| --- | --- | --- | --- | --- |

Example

{
    "minUnit": 6,
    "maxUnit": 12,
    "stepSize": 2
}

In this case:

• The minimum purchase quantity for sales is 6 units.
• The maximum purchase quantity for sales is 12 units.
• Once the minimum of 6 units is reached, additional purchases must be made in increments of 2 units.

Packaging

The packaging structure in the Product object lets you define two predefined packaging aggregation levels in which the Product can be sold: the Package (package), the Box (box) and the Pallet (pallet). These are built from the Unit (unit). The aggregation levels are structured as follows:

• A Package is a set of Units.
• A Box is a larger package that contains more Units.
• A Pallet is a much larger package that contains even more Units.

| --- | --- | --- | --- | --- |

<aside> <img src="/icons/light-bulb_gray.svg" alt="/icons/light-bulb_gray.svg" width="40px" />

</aside>

Additional attributes (otherProperties)

The model documented on this page is the base contract for the Product entity. In addition to the base fields, customers can provide additional attributes for identification, classification, segmentation, logistics, or analysis through the otherProperties object.

Some examples of additional attributes are: family, line, department, business division, additional categorical levels, manufacturer or supplier, barcode (EAN), country of origin, or storage condition.

Attributes inside otherProperties must meet the following conditions:

• Be a flat object of key-value pairs (no nested objects).
• Have stable, descriptive keys.
• Keep their data type and meaning over time.
• Not duplicate base model fields.
• Be able to be omitted or come in empty when they do not apply.
• Be reported during implementation.

YOM may retain these attributes as extended information when the integration mechanism and the pipeline allow it. Receiving an attribute does not mean that YOM uses it automatically: its analytical use or use in recommendation models must be validated during implementation.

Example with additional attributes family, line, and ean:

{
  "productId": "SKU001",
  "name": "Harina de Trigo Integral",
  "description": "Harina de trigo integral orgánica, ideal para panaderías.",
  "brand": "Harina YOM",
  "isDisabled": false,
  "tags": ["alimentos", "harinas", "orgánico"],
  "pricePerUnit": 8092,
  "otherProperties": {
    "family": "Abarrotes",
    "line": "Panificación",
    "ean": "7801234567890"
  }
}