YOM Docs

Pedido mínimo

A YOM pode delegar ao sistema do cliente a validação do pedido mínimo. Quando um comércio ou um vendedor confirma um pedido, a YOM envia uma solicitação HTTP POST ao endpoint do cliente com o detalhe do Commerce e do Order. O cliente responde se o pedido cumpre ou não o mínimo e, opcionalmente, qual é o valor mínimo exigido.

<aside> 📝

O cliente só precisa expor o endpoint na rota padrão e informar à YOM o seu domínio. Nenhuma outra configuração é necessária.

</aside>

Endpoint

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

Cabeçalhos que a YOM envia

Corpo da solicitação

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

Campos

Order

A entidade order.

Campo Tipo Obrigatoriedade Descrição Exemplos
_id 🆔 ObjectId 🟢 Obrigatório Identificador do Pedido na YOM.
*\Não é estável na chamada anterior à confirmação. "6712fa9b8c1d2e3f40567890"
domain 📝 Texto 🟢 Obrigatório Domínio do cliente ao qual o pedido pertence. "cliente.youorder.me"
status 📝 Texto 🟢 Obrigatório Status do pedido no momento da validação. "pending"
type 📝 Texto 🟢 Obrigatório Tipo de pedido.
"order" → pedido
"quote" → cotação "order"
shippingAddress 📝 Objeto 🟢 Obrigatório Endereço de entrega do pedido.
products 🔡 Lista de Objetos → OrderProduct 🟢 Obrigatório Linhas do pedido. Ver detalhe abaixo.
pricing 📝 Objeto → OrderPricing 🟢 Obrigatório Totais do pedido. Ver detalhe abaixo.
commerceId 📝 Texto ⚪ Opcional Identificador do Comércio na YOM. "65f0a1b2c3d4e5f601234567"
commerceName 📝 Texto ⚪ Opcional Nome do Comércio. "Almacén Doña Rosa"
externalId 📝 Texto ⚪ Opcional Código do Comércio no sistema do cliente. "CLI-004512"
sellerId 🔡 Lista de Textos ⚪ Opcional Identificadores do ou dos Vendedores associados ao pedido. ["186"]
externalSellerIds 🔡 Lista de Textos ⚪ Opcional Códigos do Vendedor no sistema do cliente. ["V-0186"]
receiptType 📝 Texto ⚪ Opcional Tipo de documento solicitado.
"boleta" · "factura" · "none" (padrão) "factura"
orderDate 📅 Data ⚪ Opcional Data de criação do pedido no formato ISO 8601. "2026-08-10T14:22:05.113Z"
distributionCenterId 🆔 ObjectId ⚪ Opcional Centro de distribuição associado ao pedido. "650a1b2c3d4e5f6a7b8c9d99"
distributionCenterName 📝 Texto ⚪ Opcional Nome do Centro de distribuição. "CD Santiago"
coupon 📝 Objeto ⚪ Opcional Cupom aplicado ao pedido.
sellerDiscounts 🔡 Lista de Objetos ⚪ Opcional Descontos aplicados pelo Vendedor.
observation 📝 Texto ⚪ Opcional Observação do pedido. "Entregar por la mañana"

OrderProduct

Cada linha de order.products.

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

OrderPricing

O objeto order.pricing.

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

Commerce

A entidade commerce.