Segmentos

Carregados seus Comércios, é possível segmentá-los.

O que é um Segmento?

Um Segmento é a definição de prioridade para cada Comércio.

Os Segmentos permitem categorizar Comércios e definir prioridades para a aplicação de preços e outros benefícios associados. A entidade Segmentos contém informações-chave sobre cada Segmento, incluindo seu nome, identificador externo do Comércio e prioridade.

Endpoint

GET /api/segment

ARQUIVO <fecha>_<hora>_segment.csv

Campos

Campo	Tipo	Obrigatoriedade	Descrição	Exemplos
`segmentId`	📝 Texto	🟢 Obrigatório	Identificador único do Segmento.	`“SEG001”`
`name`	📝 Texto	🟢 Obrigatório	Nome do Segmento.	`"Segmento VIP"`
`commerceIds`	🔠 Lista de textos	🟢 Obrigatório	Identificador externo do Comércio.
Deve coincidir com o campo userId na carga de
Comércios	`"EXT001"`
`priority`	🔢 Número	🟢 Obrigatório	Prioridade do segmento; é utilizada para definir a prioridade de todos os preços associados.
Se um Comércio* tem mais de um Segmento, prevalecerá o que tem o menor número de prioridade (`1`>`2`).
Se os Segmentos* estão vinculados a produtos diferentes, ambos serão aplicados para o produto que corresponder.
⚠️ A prioridade de um segmento deve ser única para todos os comércios, ou seja, se eu tenho o segmento SEG001, este deve ter SEMPRE a mesma prioridade para todos os comércios.	`1`

Resposta

A resposta do endpoint de Segmentos fornece um JSON que contém as informações detalhadas de cada segmento, permitindo uma gestão eficaz e organizada.

Exemplo de Resposta

{
  "segmentId": "SEG001",
  "name": "Segmento VIP",
  "commerceId": "EXT001",
  "priority": 1
}

Esta estrutura permite gerenciar e consultar as informações dos segmentos na YOM de maneira eficiente.

Etapas anteriores

Promoções

</aside>

Próximas etapas

</aside>