El primer paso para comenzar a funcionar con YOM es registrar a tus comercios.
¿Quienes son los comercios? Los clientes en YOM son los comercios a quienes ofreces tus productos.
Estos comercios se representan en la entidad Commerce. Un Commerce contiene la información de cada comercio, sus usuarios asociados y lógicas de venta. Los comercios en YOM representarán una entidad comercial con la cual se interactúa para diversas operaciones, como ordenes y gestión de productos.
El endpoint de Comercios le permite a YOM acceder a información detallada sobre cada comercio registrado.
GET /api/commerces
La siguiente tabla define el modelo base de integración de la entidad Commerce. Este modelo corresponde al contrato base y es extensible: puede complementarse con atributos adicionales a través del objeto otherProperties, según se describe en la sección Atributos adicionales.
| Campo | Tipo | Carácter | Descripción | Ejemplos |
|---|---|---|---|---|
commerceId |
📝 Texto | 🟢 Requerido | Identificador único del Comercio. | “12345” |
globalCommerceId |
📝 Texto | ⚪ Opcional | RUT / CI del Comercio. | "76.345.678-9" |
name |
📝 Texto | 🟢 Requerido | Nombre del Comercio. | "Panadería Don Carlos" |
email |
📝 Texto | ⚪ Opcional | Correo electrónico del Comercio | "[email protected]" |
phone |
📝 Texto | ⚪ Opcional | Teléfono del Comercio | “+5691231233” |
class |
📝 Texto | 🟢 Requerido | Categoría del Comercio. | “Panadería” |
locations |
🔠 Lista de Objetos → Comercios | 🟢 Requerido | Ubicaciones del Comercio. | [{"address": "Avenida Apoquindo 123, Departamento 456, Las Condes", "commune": "Las Condes", "city": "Santiago", "region": "Región Metropolitana","country": "Chile"}] |
createdDate |
📅 Fecha | 🟢 Requerido | Fecha de creación del Comercio. | |
| *\*La fecha debe estar en formato ISO 8601. | ||||
| *Es la fecha en la que el Comercio comenzó a trabajar con el cliente, *no al fecha en la que se carga a YOM. | “2023-04-27” |
|||
“2018-10-22T00:00:00.000Z” |
||||
isInactive |
🔘 Bool | 🟢 Requerido | ¿Está desactivado el Comercio? | true |
false |
||||
channel |
📝 Texto | 🟢 Requerido | Canal por el cual es atendido el Comercio. | “Canal Tradicional” |
subChannel |
📝 Texto | 🟢 Requerido | Sub canal por el cual es atendido el Comercio. | “Canal almacenes” |
nextVisitDate |
📅 Fecha | ⚪ Opcional | Fecha de próxima visita de un Vendedor al Comercio. Si se envía esta fecha, se usa, sino se calcula en base a visitPlan |
|
| *\La fecha debe estar en formato ISO 8601. | “2023-04-27” |
|||
“2018-10-22T00:00:00.000Z” |
||||
nextDeliveryDate |
📅 Fecha | ⚪ Opcional | Fecha de próxima entrega de mercancía para el Comercio. | |
| *\La fecha debe estar en formato ISO 8601. | “2023-04-27” |
|||
“2018-10-22T00:00:00.000Z” |
||||
visitPlan |
📝 Texto | ⚪ Opcional | Plan de visita semanal del Comercio. | |
| *\Deben ser los días de la semana de visita | “monday,friday” |
|||
visitRoute |
📝 Texto | ⚪ Opcional | Lista de “<semana del mes>-<dia de semana><canal origen>” | |
*\*Canal origen puede ser *C: Call center, V: Vendedor. |
“1-2C,1-5V,2-1V,2-5V,3-5C” |
|||
distributionCenterIds |
🔠 Lista de textos → Centro de Distribución | ⚪ Opcional | Lista de Ids de los Centros de distribución | ["32", "2"] |
deliveryDateBydistributionCenter |
🔠 Objeto → { distributionCenterId: [fechas de despacho]} | ⚪ Opcional | Lista de fechas de despacho por Centros de distribución | {"1": ["2026-05-05", "2026-05-07", "2026-05-09"],"2": ["2026-05-06", "2026-05-08"]} |
sellerIds |
🔠 Lista de textos → Vendedores | 🟢 Requerido | Lista de Ids del o los vendedores asignados al comercio | ["1234", "7876"] |
paymentDescription |
📝 Texto | ⚪ Opcional | Descripción de las condiciones de pago del comercio | Cheque a 15 días |
otherProperties |
📝 Objeto | ⚪ Opcional | Objeto clave-valor con atributos adicionales del Comercio. Ver sección Atributos adicionales. | {"salesZone": "Zona Oriente", "priceList": "LP-04"} |
El objeto location en un Comercio contiene la información de ubicación del Comercio. Agrupa los campos relacionados con la dirección y ubicación geográfica del Comercio.
| Campo | Tipo | Carácter | Descripción | Ejemplos |
|---|---|---|---|---|
address |
📝 Texto | 🟢 Requerido | Dirección completa del Comercio. | "Avenida Apoquindo 123, Departamento 456, Las Condes" |
commune |
📝 Texto | 🟢 Requerido | Comuna del Comercio. | "Las Condes" |
city |
📝 Texto | 🟢 Requerido | Ciudad del Comercio. | “Santiago” |
region |
📝 Texto | 🟢 Requerido | Región del Comercio. | “Región Metropolitana” |
country |
📝 Texto | 🟢 Requerido | País del Comercio. | “Chile” |
coordinates |
📝 Objeto → Coordinates | ⚪ Opcional | Coordenadas de la dirección del Comercio. | {"latitude": , "longitude": } |
locality |
📝 Texto | ⚪ Opcional | Localidad del Comercio. | "San Carlos de Apoquindo" |
premises |
📝 Texto | ⚪ Opcional | Local comercial | “Local 43” |
| Campo | Tipo | Carácter | Descripción | Ejemplos |
|---|---|---|---|---|
latitude |
📝 Texto | 🟢 Requerido | Latitud | “40.7128” |
longitude |
📝 Texto | 🟢 Requerido | Longitud | “-74.0060" |
Ejemplo
{
"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"
}
}
otherProperties)El modelo documentado en esta página corresponde al contrato base de la entidad Commerce. Además de los campos base, los clientes pueden disponibilizar atributos adicionales para identificación, clasificación, segmentación, logística o análisis, a través del objeto otherProperties.
Algunos ejemplos de atributos adicionales son: zona o territorio de venta, lista de precios, cluster o segmento interno, ejecutivo key account o frecuencia de compra.
Los atributos dentro de otherProperties deben cumplir las siguientes condiciones:
channel, class o paymentDescription).YOM podrá conservar estos atributos como información extendida cuando el mecanismo de integración y el pipeline lo permitan. Recibir un atributo no implica que YOM lo utilice automáticamente: su uso analítico o en modelos de recomendación debe validarse durante la implementación.
Ejemplo con atributos adicionales salesZone, priceList y cluster:
{
"commerceId": "12345",
"name": "Panadería Don Carlos",
"class": "Panadería",
"channel": "Canal Tradicional",
"subChannel": "Canal almacenes",
"isInactive": false,
"otherProperties": {
"salesZone": "Zona Oriente",
"priceList": "LP-04",
"cluster": "Oro"
}
}
La respuesta del endpoint de Comercios devuelve un JSON que contiene la información detallada de cada comercio registrado en YOM, incluyendo datos de contacto, direcciones, crédito disponible, días de visita, entre otros.
{
"commerceId": "12345",
"globalCommerceId": "76.345.678-9",
"name": "Panadería Don Carlos",
"email": "[email protected]",
"phone": "+56912342314",
"class": "Panadería",
"locations": [
{
"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"
}
}
],
"isInactive": false,
"createdDate": "2023-04-27T00:00:00.000Z",
"nextVisitDate": "2018-10-22T00:00:00.000Z",
"nextDeliveryDate": "2023-04-27T00:00:00.000Z",
"channel": "Canal Tradicional",
"subChannel": "Canal almacenes",
"visitPlan": "monday,friday",
"visitRoute": "1-2C,1-5V,2-1V,2-5V,3-5C",
"distributionCenterIds": ["1","2"]
}
Pasos anteriores
<aside> <img src="/icons/arrow-left_gray.svg" alt="/icons/arrow-left_gray.svg" width="40px" /> Implementación
</aside>
Siguientes pasos
<aside> <img src="/icons/arrow-right_gray.svg" alt="/icons/arrow-right_gray.svg" width="40px" /> Productos
</aside>