YOM Docs

Vendedores

Com seus Comércios e Produtos configurados, é hora de adicionar seus Vendedores.

Quem são os vendedores? Os Vendedores na YOM são quem atende ou visita em campo os Comércios.

São representados na entidade Seller. Um Seller contém as informações necessárias para gerenciá-los, incluindo identificadores, contatos e supervisores.

Endpoint

GET /api/seller

ARQUIVO <fecha>_<hora>_seller.csv

Campos

Seller

O objeto seller contém informações sobre o Vendedor. Isso inclui identificadores, contato e dados adicionais sobre o status ou supervisão do Vendedor.

Campo Tipo Obrigatoriedade Descrição Exemplos
sellerId 📝 Texto 🟢 Obrigatório Identificador único do Vendedor. "V001"
name 📝 Texto 🟢 Obrigatório Nome do Vendedor. "Carlos García"
email 📝 Texto ⚪ Opcional E-mail do Vendedor. "[email protected]"
phone 📝 Texto ⚪ Opcional Telefone do Vendedor. `"+123456789"``
governmentId 📝 Texto ⚪ Opcional RUT / CI do Vendedor. “18888888-8”
supervisorIds 🗂️ Lista de Textos ⚪ Opcional Lista de identificadores dos supervisores do Vendedor.
Supervisores ["S001", "S002"]
isInactive 🔘 Bool ⚪ Opcional O Vendedor está desativado? true
false

Resposta

A resposta do endpoint de Vendedores fornece um JSON que contém as informações detalhadas de cada vendedor, incluindo seus supervisores e dados de contato.

Exemplo de Resposta

{
  "sellerId": "V001",
  "name": "Carlos García",
  "email": "[email protected]",
  "phone": "+123456789",
  "governmentId": "18888888-8",
  "supervisorIds": ["S001", "S002"],
  "isInactive": false
}

Com esta estrutura, você poderá gerenciar e consultar as informações dos vendedores na YOM de maneira eficiente e organizada.

Etapas anteriores

<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" />

</aside>