YOM Docs
2026 Outubro 05 → 2.0.0
A documentação foi reorganizada. As páginas que foram retiradas deixam de estar disponíveis; seu conteúdo está nas novas seções.
Nova estrutura
- É criada Formas de integração, que reúne as duas formas de enviar dados para a YOM:
- Integração por API: unifica as antigas páginas API Programada, Requisitos técnicos, Endpoints a disponibilizar e Implementação.
- Integração por arquivos: unifica as antigas páginas Arquivos (Carga de dados), Inteligência, Operacional, Arquivos a disponibilizar e Implementação, e inclui a estrutura de pastas, o nome do arquivo de cada entidade e o formato CSV.
- É criada Entidades, com o modelo de dados de cada entidade. O modelo é o mesmo para a integração por API e por arquivos.
- São retiradas as páginas de entidades por arquivo (Comércios, Produtos, Transações, Vendedores, Categorias, Estoque, entre outras), cujo conteúdo já estava documentado em cada entidade.
Entidades
- Cada entidade indica, junto ao seu endpoint, o nome do arquivo com o qual se integra por arquivos (
<fecha>_<hora>_<entidad>.csv).
- É adicionado o endpoint
GET /api/promotion a Promoções.
Webhooks
- Criação de comércios passa a ser Webhooks da YOM para o cliente e é reescrita conforme o contrato vigente: corpo
commerceRequest com as respostas do formulário, estados approved, rejected, observations e pending, objeto commerceData para criar o comércio, tempo máximo de resposta de 70 segundos e sem novas tentativas automáticas. É eliminada a consulta periódica de status por GET.
Navegação
- O menu lateral é exibido expandido em todas as páginas.
- Todas as páginas incluem os acessos Etapas anteriores e Próximas etapas, na ordem do menu.
- A largura das colunas é ajustada para dar mais espaço ao conteúdo.
2024 Dezembro 19 → 1.4.1
Atualizada a entidade Categoria.
São substituídos os campos categoryKey e parentCategoryKey por categoryId e parentCategoryId para seguir a convenção das outras entidades → Categorias
2024 Dezembro 18 → 1.4.0
Atualizada a injeção de dados via Webhooks. Adicionada a injeção de Pedidos e Pagamentos. → Webhooks
2024 Dezembro 13 → 1.3.0
Atualizada a entidade Comércio.
- É adicionado o campo
locations que permite listar as localizações físicas do Comércio → Comércios. Ele substitui o campo location.
- Vendedores,Supervisores
- Fica obsoleto o uso dos campos
administrativeLevel e logisticalLevel.
Atualizada a entidade Produto.
- Fica obsoleto o uso de
measurement e packaging. É substituído pelo uso de formats e constraints → Produtos
Atualizada a entidade Sobrescrita.
- É adicionada a capacidade de sobrescrever o campo
constraints de um Produto por meio de uma Sobrescrita.
2024 Dezembro 12 → 1.2.0
- Atualizada a entidade Promoções. É adicionada a explicação de seus tipos, objetivos e a lógica das Regras de Promoções → Promoções
2024 Dezembro 06 → 1.1.0
- Atualizada a entidade Pagamentos para suportar múltiplos documentos, detalhes e registro de transações externas → Pagamentos
2024 Dezembro 05 → 1.0.5
- É adicionado filtro sobre o campo
date como obrigatório na integração via API Programada de Transactions.
2024 Novembro 27 → 1.0.4
- São corrigidos os exemplos para a entidade Product. ****Incluem a mudança do uso de
sku por productId da versão 1.0.2.
2024 Setembro 24 → 1.0.3
2024 Julho 19 → 1.0.2
- É definido o campo
location de Comércio.
- São definidos os campos
dimensions, measurement, packaging e formats de Produto como opções para o gerenciamento de formatos de venda.
- É substituído o uso de
sku por productId em Produto. Sugere-se o uso de SKU como identificador único do Produto mas é possível usar um identificador diferente deste.
2024 Julho 03 → 1.0.1
- São unificadas as referências a Comércios ao longo de todas as entidades. ****É substituído o uso das palavras user e client em todas as suas versões por commerce. Isso considera os campos:
2024 Julho 01 → 1.0.0