Skip to main content

API Stock

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

Sección 1: URL y método

Sección 2: acceso

Sección 3: parámetros generales del payload

  • hierarchy
  • views
  • 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".

Parámetros de dates

  • Se debe indicar cada una de las fechas que se quiera visualizar. Por ejemplo: ["2021-02-22"], ["2021-02-23"], ..., ["2021-02-28"]. La API de stock dispone solo de los últimos 15 días más recientes para descargar.

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 stock hasta:

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

Parámetros extra

  • chain_code: trae los códigos de cadena para cada producto.
  • format: puede ser "json", "zip" o "csv". Define el formato de salida del resultado.
  • in_stock: el valor "true" incluye las columnas de "instock" a 1, 3 y 5 días en el archivo descargado. El ejemplo trae por defecto el parámetro en "false".
  • last_category_update: el valor "true" reemplaza las fechas indicadas en dates y permite traer la información del inventario más reciente de cada cadena.
  • 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.
  • over_stock: el valor "true" incluye la columna sobre stock en el archivo descargado. El ejemplo trae por defecto el parámetro en "false".

Ejemplo


curl --location --request POST 'https://api.instoreview.cl/api/v2/download-zone/stock/' \
--header 'Authorization: ISVToken *****************************' \
--header 'Content-Type: application/json' \
--data-raw '{
"dates": ["2024-08-12"],
"views": ["Unidades", "Costos B2B", "Venta Costo", "Kilos", "Ventas B2B", "Venta PVP sin IVA", "Cajas"],
"format": "csv",
"in_stock": false,
"over_stock": false,
"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