YOM Docs

Untitled

Untitled

Untitled

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

Campos

Campo Tipo Carácter Descripción Ejemplos
segmentId 📝 Texto 🟢 Requerido Identificador único del Segmento. “SEG001”
name 📝 Texto 🟢 Requerido Nombre del Segmento. "Segmento VIP"
commerceId 📝 Texto 🟢 Requerido Identificador externo del Comercio.
Debe coincidir con el campo userId en la carga de
"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. 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

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

</aside>

Siguientes pasos

<aside> <img src="/icons/arrow-right_gray.svg" alt="/icons/arrow-right_gray.svg" width="40px" /> Centro de Distribución

</aside>

Tabla de contenidos