A YOM pode delegar ao sistema do cliente a aprovação de novos comércios. Quando um vendedor preenche no aplicativo da YOM o formulário de cadastro de um comércio, a YOM envia uma requisição HTTP POST ao endpoint do cliente com as respostas do formulário. O cliente responde se aprova, rejeita ou observa a solicitação e, se a aprova, entrega os dados com os quais o Comércio é criado na YOM.
<aside> 📝
O cliente deve expor o endpoint e informar à YOM sua URL completa. O formulário de cadastro (perguntas e opções) é configurado junto com a YOM durante a implementação.
</aside>
approved → o comércio é criado na YOM com os dados entregues e fica disponível para receber pedidos.rejected → a solicitação é rejeitada e o comércio não é criado.observations → a solicitação requer correções; o vendedor as vê no aplicativo, corrige e envia novamente.pending → a solicitação foi recebida e está em revisão no sistema do cliente.pending é encerrada quando o comércio chega à YOM por meio da carga habitual de Comércios.POST <url_informada_por_el_cliente>
Cabeçalhos que a YOM envia
Content-Type: application/jsonx-auth-token: {identificador del cliente en YOM}origin: legacy.youorder.meCorpo da requisição
{
"commerceRequest": { ... }
}
A solicitação de criação de comércio.
| Campo | Tipo | Obrigatoriedade | Descrição | Exemplos |
|---|---|---|---|---|
_id |
🆔 ObjectId | 🟢 Obrigatório | Identificador da solicitação na YOM. Recomenda-se usá-lo como chave de idempotência. | "66fd1a2b3c4d5e6f7a8b9c0d" |
domain |
📝 Texto | 🟢 Obrigatório | Domínio do cliente ao qual a solicitação pertence. | "cliente.youorder.me" |
status |
📝 Texto | 🟢 Obrigatório | Estado da solicitação no momento do envio. | "pending" |
form |
🔡 Lista de Objetos → FormAnswer | 🟢 Obrigatório | Respostas do formulário de cadastro. Ver detalhe abaixo. | |
tempId |
📝 Texto | ⚪ Opcional | Identificador temporário da solicitação gerado pelo aplicativo. É mantido se o vendedor reenviar a solicitação. | "lead-9f3a1c" |
requestNum |
🔢 Número | ⚪ Opcional | Número sequencial da solicitação. | 783 |
externalSellerId |
📝 Texto | ⚪ Opcional | Código do Vendedor que criou a solicitação no sistema do cliente. | "V015" |
source |
📝 Objeto | ⚪ Opcional | Origem da solicitação: sourceType (por exemplo "seller") e sourceExternalId (código do vendedor). |
{"sourceType": "seller", "sourceExternalId": "V015"} |
createdBy |
📝 Texto | ⚪ Opcional | Usuário que criou a solicitação. | "[email protected]" |
createdAt |
📅 Data | 🟢 Obrigatório | Data de criação da solicitação no formato ISO 8601. | "2026-10-02T14:32:00.000Z" |
Cada elemento de commerceRequest.form. As perguntas dependem do formulário configurado para o cliente.