Segmentos

Cargados tus Comercios, es posible segmentarlos.

¿Qué es un Segmento?

Un Segmento es la definición de prioridad para cada Comercio.

Los Segmentos permiten categorizar Comercios y definir prioridades para la aplicación de precios y otros beneficios asociados. La entidad Segmentos contiene información clave sobre cada Segmento, incluyendo su nombre, identificador externo del Comercio y prioridad.

Endpoint

GET /api/segment

ARCHIVO <fecha>_<hora>_segment.csv

Campos

Campo	Tipo	Carácter	Descripción	Ejemplos
`segmentId`	📝 Texto	🟢 Requerido	Identificador único del Segmento.	`“SEG001”`
`name`	📝 Texto	🟢 Requerido	Nombre del Segmento.	`"Segmento VIP"`
`commerceIds`	🔠 Lista de textos	🟢 Requerido	Identificador externo del Comercio.
Debe coincidir con el campo userId en la carga de
Comercios	`"EXT001"`
`priority`	🔢 Número	🟢 Requerido	Prioridad del segmento, se utiliza para definir la prioridad de todos los precios asociados.
Si un Comercio* tiene más de un Segmento, se impondrá el que tiene el menor número de prioridad (`1`>`2`).
Si los Segmentos* están vinculados a distintos productos, ambos se aplicarán para el producto que corresponda.
⚠️ La prioridad de un segmento debe ser única para todos los comercios, es decir, si tengo el segmento SEG001 este debe tener SIEMPRE la misma prioridad para todos los comercios.	`1`

Respuesta

La respuesta del endpoint de Segmentos proporciona un JSON que contiene la información detallada de cada segmento, permitiendo una gestión eficaz y organizada.

Ejemplo de Respuesta

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

Esta estructura permite gestionar y consultar la información de los segmentos en YOM de manera eficiente.

Pasos anteriores

Promociones

</aside>

Siguientes pasos

</aside>