Skip to main content

API Sell Out

A continuación, te presentamos las características de nuestra API y cómo utilizarla en el sell out.

Sección 1: URL y método

Sección 2: acceso

Sección 3: parámetros generales del payload

  • hierarchy
  • views
  • views_type
  • dates

Parámetros de hierarchy

  • Son las posibles agrupaciones de la data a obtener. Por ejemplo: "Cadena", "Formato", "Región", "Comuna", "Local", "Supervisor", "Reponedor", "Zona Nielsen", "Cluster", "Categoría", "Sub Categoría", "EAN13", "Descripción Producto", "Marca".

Parámetros de views

  • Son las posible valorizaciones de la data a obtener. "Unidades", "Costos B2B", "Venta Costo", "Kilos", "Ventas B2B", "Venta PVP sin IVA", "Cajas", "Precios B2B".

Parámetros de dates

  • Se debe indicar cada una de las fechas que se quiera visualizar. Por ejemplo: ["2021-02-22"], ["2021-02-23"],...

Parámetros de view_type

  • Es cómo se decide agrupar la data según fechas. Por ejemplo:
    1. "ytd" (Year to Date):
      Formato "dates": ["YYYY"]
    2. "mat" (Moving Anual Total):
      Formato "dates": ["YYYY"]
    3. "mes" (Mensual):
      Formato "dates": ["YYYY-MM"]
    4. "semana" (Semanal):
      Formato "dates": ["YYYY-Ww"], ejemplo ["2018-W13"], ejemplo ["2019-W02"]
    5. "diario" (Diaria):
      Formato "dates": ["DD"], ejemplo ["2018-02-12"]
    6. "year" (Año):
      Formato "dates": ["YYYY"], ejemplo ["2019"]

Fechas máximas a consultar por cadena:

Cada cadena tiene la información actualizada hasta una fecha diferente, según la disponibilidad del portal b2b, por ello las cadenas estarán con las ventas hasta:

  • Tottus: 2024-08-11
  • Walmart: 2024-08-11
  • Cencosud: 2024-08-10
  • SMU: 2024-08-10

Parámetros extra

  • format: puede ser "json", "zip" o "csv". Define el formato de salida del resultado.
  • chain_code: trae los códigos de cadena para cada dato.
  • only_active_products: filtra los productos para que solo se muestren aquellos que estén definidos como "activos" por la maestra de productos del cliente.

Ejemplo


curl --location --request POST 'https://api.instoreview.cl/api/v2/download-zone/sales/' \
--header 'Authorization: ISVToken *****************************' \
--header 'Content-Type: application/json' \
--data-raw '{
"view_type": "diario",
"dates": ["2024-08-11"],
"views": ["Unidades", "Costos B2B", "Venta Costo", "Kilos", "Ventas B2B", "Venta PVP sin IVA", "Cajas", "Precios B2B"],
"format": "csv",
"chain_codes": [ ],
"hierarchy": {
"Cadena": [ ],
"Formato": [ ],
"Región": [ ],
"Comuna": [ ],
"Local": [ ],
"Supervisor": [ ],
"Reponedor": [ ],
"Zona Nielsen": [ ],
"Cluster": [ ],
"Categoría": [ ],
"Sub Categoría": [ ],
"EAN13": [ ],
"Descripción Producto": [ ],
"Marca": [ ]
}}'

Back to top