YOM Docs

O primeiro passo para começar a operar com a YOM é cadastrar seus comércios.

Quem são os comércios? Os clientes na YOM são os comércios a quem você oferece seus produtos.

Estes comércios são representados na entidade Commerce. Um Commerce contém as informações de cada comércio, seus usuários associados e lógicas de venda. Os comércios na YOM representarão uma entidade comercial com a qual se interage para diversas operações, como pedidos e gestão de produtos.

Endpoint

O endpoint de Comércios permite que a YOM acesse informações detalhadas sobre cada comércio cadastrado.

GET /api/commerces

ARQUIVO <fecha>_<hora>_commerce.csv

Campos

A tabela a seguir define o modelo base de integração da entidade Commerce. Este modelo corresponde ao contrato base.

Commerce

Campo Tipo Obrigatoriedade Descrição Exemplos
commerceId 📝 Texto 🟢 Obrigatório Identificador único do Comércio. “12345”
globalCommerceId 📝 Texto ⚪ Opcional RUT / CI do Comércio. "76.345.678-9"
name 📝 Texto 🟢 Obrigatório Nome do Comércio. "Panadería Don Carlos"
email 📝 Texto ⚪ Opcional E-mail do Comércio "[email protected]"
phone 📝 Texto ⚪ Opcional Telefone do Comércio “+5691231233”
class 📝 Texto 🟢 Obrigatório Categoria do Comércio. “Panadería”
locations 🔠 Lista de Objetos → Comércios 🟢 Obrigatório Localizações do Comércio. [{"address": "Avenida Apoquindo 123, Departamento 456, Las Condes", "commune": "Las Condes", "city": "Santiago", "region": "Región Metropolitana","country": "Chile"}]
createdDate 📅 Data 🟢 Obrigatório Data de criação do Comércio.
*\*A data deve estar no formato ISO 8601.
*É a data em que o Comércio começou a trabalhar com o cliente, *não a data em que é carregado na YOM. “2023-04-27”
“2018-10-22T00:00:00.000Z”
isInactive 🔘 Bool 🟢 Obrigatório O Comércio está desativado? true
false
channel 📝 Texto 🟢 Obrigatório Canal pelo qual o Comércio é atendido. “Canal Tradicional”
subChannel 📝 Texto 🟢 Obrigatório Subcanal pelo qual o Comércio é atendido. “Canal almacenes”
nextVisitDate 📅 Data ⚪ Opcional Data da próxima visita de um Vendedor ao Comércio. Se esta data for enviada, ela é usada; caso contrário, é calculada com base em visitPlan
*\A data deve estar no formato ISO 8601. “2023-04-27”
“2018-10-22T00:00:00.000Z”
nextDeliveryDate 📅 Data ⚪ Opcional Data da próxima entrega de mercadoria para o Comércio.
*\A data deve estar no formato ISO 8601. “2023-04-27”
“2018-10-22T00:00:00.000Z”
visitPlan 📝 Texto ⚪ Opcional Plano de visita semanal do Comércio.
*\Devem ser os dias da semana de visita “monday,friday”
visitRoute 📝 Texto ⚪ Opcional Lista de “<semana do mês>-<dia da semana><canal de origem>”
*\*Canal de origem pode ser *C: Call center, V: Vendedor. “1-2C,1-5V,2-1V,2-5V,3-5C”
routeIndex 🔢 Número ⚪ Opcional Ordem em que o comércio aparecerá nas rotas. Se o número for 1, aparecerá na posição 1; se for 10, aparecerá na posição 10. 0
distributionCenterIds 🔠 Lista de textos → Centro de Distribuição ⚪ Opcional Lista de Ids dos Centros de distribuição ["32", "2"]
deliveryDateBydistributionCenter 🔠 Objeto → { distributionCenterId: [datas de entrega]} ⚪ Opcional Lista de datas de entrega por Centros de distribuição {"1": ["2026-05-05", "2026-05-07", "2026-05-09"],"2": ["2026-05-06", "2026-05-08"]}
sellerIds 🔠 Lista de textos → Vendedores 🟢 Obrigatório Lista de Ids do(s) vendedor(es) atribuído(s) ao comércio ["1234", "7876"]
paymentDescription 📝 Texto ⚪ Opcional Descrição das condições de pagamento do comércio Cheque a 15 días
configuration 📝 Objeto → Configuration ⚪ Opcional Configuração comercial específica do Comércio. {"minimumOrderTotal": 15000}
additionalInfo 📝 Objeto ⚪ Opcional Objeto chave-valor com atributos adicionais do Comércio. {"salesZone": "Zona Oriente", "priceList": "LP-04"}

Location

O objeto location em um Comércio contém as informações de localização do Comércio. Agrupa os campos relacionados ao endereço e à localização geográfica do Comércio.

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

Coordinates

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

Exemplo

{
    "address": "Avenida Apoquindo 123, Departamento 456, Las Condes",
    "commune": "Las Condes",
    "city": "Santiago",
    "region": "Región Metropolitana",
    "country": "Chile",
    "locality": "San Carlos de Apoquindo",
    "coodinates": {
	    "latitude": "40.7128",
	    "longitude": "-74.0060"
    }
}

Configuration

O objeto configuration em um Comércio agrupa a configuração comercial específica desse Comércio. Os valores informados neste objeto têm prioridade sobre a configuração geral definida para o cliente.

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

Exemplo

{
    "minimumOrderTotal": 15000
}

Resposta

A resposta do endpoint de Comércios retorna um JSON que contém as informações detalhadas de cada comércio cadastrado na YOM, incluindo dados de contato, endereços, crédito disponível, dias de visita, entre outros.

Exemplo de Resposta