YOM Docs

Untitled

Untitled

Untitled

Comercios

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.

Carpeta y nombre de archivos

El archivo de Comercios le permite a YOM acceder a información detallada sobre cada comercio registrado.

Entidad → commerce

/<nombre_cliente>
	/production
		/load
			/commerce
				/all
					20240201_180000_commerce.csv
					...
				/created
					...
				/updated
					...
	/development
		...

Commerce

Campo Tipo Carácter Descripción Ejemplos
commerceId 📝 Texto 🟢 Requerido Identificador único del Comercio. “12345”
globalCommerceId 📝 Texto 🟡 Recomendado RUT / CI del Comercio. "76.345.678-9"
name 📝 Texto 🟢 Requerido Nombre del Comercio. "Panadería Don Carlos"
email 📝 Texto 🟢 Requerido Correo electrónico del Comercio "[email protected]"
phone 📝 Texto 🟡 Recomendado Teléfono del Comercio “+5691231233”
class 📝 Texto 🟢 Requerido Categoría del Comercio. “Panadería”
locations 🔠 Lista de Objetos → Location 🟢 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 🟡 Recomendado Canal por el cual es atendido el Comercio. “Canal Tradicional”
subChannel 📝 Texto 🟡 Recomendado 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 🟢 Requerido 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 🟡 Recomendado Lista de Ids de los Centros de distribución ["32", "2"]

Location

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 ⚪ Opcional 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": }

Coordinates

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",
    "coodinates": {
	    "latitude": "40.7128",
	    "longitude": "-74.0060"
    }
}

Archivo

El archivo de Comercios 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.

Objeto JSON Original

{
  "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",
	    "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"]
}

CSV Aplanado

commerceId;globalCommerceId;name;email;phone;class;locations_address;locations_commune;locations_city;locations_region;locations_country;locations_coodinates_latitude;locations_coodinates_longitude;isInactive;createdDate;nextVisitDate;nextDeliveryDate;sellerId;supervisorId;channel;subChannel;visitPlan;visitRoute;distributionCenterIds
12345;76.345.678-9;Panadería Don Carlos;[email protected];+56912342314;Panadería;Avenida Apoquindo 123, Departamento 456, Las Condes;Las Condes;Santiago;Región Metropolitana;Chile;40.7128;-74.0060;false;2023-04-27T00:00:00.000Z;2018-10-22T00:00:00.000Z;2023-04-27T00:00:00.000Z;67890;54321;Canal Tradicional;Canal almacenes;monday,friday;1-2C,1-5V,2-1V,2-5V,3-5C;1|2

Lista de campos CSV

Columna Valor
commerceId 12345
globalCommerceId 76.345.678-9
name Panadería Don Carlos
email [email protected]
phone +56912342314
class Panadería
location_address Avenida Apoquindo 123, Departamento 456, Las Condes
locations_commune Las Condes
locations_city Santiago
locations_region Región Metropolitana
locations_country Chile
locations_latitude 40.7128
locations_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
sellerId 67890
supervisorId 54321
channel Canal Tradicional
subChannel Canal almacenes
visitPlan monday,friday
visitRoute 1-2C,1-5V,2-1V,2-5V,3-5C
distributionCenterIds 1,2