YOM Docs

Minimum order

YOM can delegate minimum order validation to the customer's system. When a commerce or a seller confirms an order, YOM sends an HTTP POST request to the customer's endpoint with the details of the Commerce and the Order. The customer responds whether or not the order meets the minimum, and optionally what the required minimum amount is.

<aside> πŸ“

The customer only needs to expose the endpoint at the standard path and tell YOM its domain. No other configuration is required.

</aside>

Endpoint


POST <tu_dominio>/webhooks/yom/order/calculate-minimum-total

Headers YOM sends

Request body

{
  "commerce": { ... },
  "order": { ... }
}

Fields


Order

The order entity.

Field Type Requirement Description Examples
_id πŸ†” ObjectId 🟒 Required Order identifier in YOM.
*\It is not stable in the call that precedes confirmation. "6712fa9b8c1d2e3f40567890"
domain πŸ“ Text 🟒 Required Domain of the customer the order belongs to. "cliente.youorder.me"
status πŸ“ Text 🟒 Required Order status at the time of validation. "pending"
type πŸ“ Text 🟒 Required Order type.
"order" β†’ order
"quote" β†’ quote "order"
shippingAddress πŸ“ Object 🟒 Required Delivery address for the order.
products πŸ”‘ List of Objects β†’ OrderProduct 🟒 Required Order line items. See details below.
pricing πŸ“ Object β†’ OrderPricing 🟒 Required Order totals. See details below.
commerceId πŸ“ Text βšͺ Optional Commerce identifier in YOM. "65f0a1b2c3d4e5f601234567"
commerceName πŸ“ Text βšͺ Optional Commerce name. "AlmacΓ©n DoΓ±a Rosa"
externalId πŸ“ Text βšͺ Optional Commerce code in the customer's system. "CLI-004512"
sellerId πŸ”‘ List of Texts βšͺ Optional Identifiers of the Seller(s) associated with the order. ["186"]
externalSellerIds πŸ”‘ List of Texts βšͺ Optional Seller codes in the customer's system. ["V-0186"]
receiptType πŸ“ Text βšͺ Optional Type of document requested.
"boleta" Β· "factura" Β· "none" (default) "factura"
orderDate πŸ“… Date βšͺ Optional Order creation date in ISO 8601 format. "2026-08-10T14:22:05.113Z"
distributionCenterId πŸ†” ObjectId βšͺ Optional Distribution center associated with the order. "650a1b2c3d4e5f6a7b8c9d99"
distributionCenterName πŸ“ Text βšͺ Optional Distribution center name. "CD Santiago"
coupon πŸ“ Object βšͺ Optional Coupon applied to the order.
sellerDiscounts πŸ”‘ List of Objects βšͺ Optional Discounts applied by the Seller.
observation πŸ“ Text βšͺ Optional Order observation. "Entregar por la maΓ±ana"

OrderProduct

Each order.products line item.

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

OrderPricing

The order.pricing object.

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

Commerce

The commerce entity.