Cómo gestionar el stock vía API
👉 Más información sobre gestión de Stock
Obtener la cantidad de unidades en stock de un producto
URL:
https://api.webered.com/productos/{CODIGO PRODUCTO}/stock
Compatibilidad con integraciones existentes:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}/stock?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- Ninguno.
Respuesta:
Lista de stock.
Ejemplo:
{
"result": {
"count": "6",
"items": [
{
"variante1_codigo": "TAM-MEDIANO",
"variante2_codigo": "COL-ROJO",
"sku": "med-roj",
"ean": "000123456",
"cantidad": "0"
},
{
"variante1_codigo": "TAM-MEDIANO",
"variante2_codigo": "COL-AZUL",
"sku": "med-azu",
"ean": "000456789",
"cantidad": "40"
},
{
"variante1_codigo": "TAM-GRANDE",
"variante2_codigo": "COL-ROJO",
"sku": "gra-roj",
"ean": "",
"cantidad": "10"
},
{
"variante1_codigo": "TAM-GRANDE",
"variante2_codigo": "COL-AZUL",
"sku": "",
"ean": "",
"cantidad": "-55"
},
{
"variante1_codigo": "TAM-CHICO",
"variante2_codigo": "COL-ROJO",
"sku": "",
"ean": "",
"cantidad": "146"
},
{
"variante1_codigo": "TAM-CHICO",
"variante2_codigo": "COL-AZUL",
"sku": "",
"ean": "",
"cantidad": "120"
}
]
}
}
Asignar unidades de stock a un producto
URL:
https://api.webered.com/productos/{CODIGO PRODUCTO}/stock
Compatibilidad con integraciones existentes:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}/stock?apikey={CLAVE DE API}
Método HTTP:
POST
Parámetros:
- variante1_codigo: código identificador de variante 1.
- variante2_codigo: código identificador de variante 2.
- cantidad: cantidad de stock a asignar.
Respuesta:
Cantidad de stock asignada la producto:
Ejemplo:
{
"result": {
"item": {
"cantidad": "155"
}
}
}
Sumar o restar unidades de stock a un producto
URL:
https://api.webered.com/productos/{CODIGO PRODUCTO}/stock
Compatibilidad con integraciones existentes:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{CODIGO PRODUCTO}/stock?apikey={CLAVE DE API}
Método HTTP:
PUT
Parámetros:
- variante1_codigo: código identificador de variante 1.
- variante2_codigo: código identificador de variante 2.
- cantidad: cantidad de stock a sumar o restar. Si el número es positivo se sumará a la cantidad existente. Si es negativo, se restará.
Respuesta:
Cantidad de stock actualizada luego de sumar o restar:
Ejemplo:
{
"result": {
"item": {
"cantidad": "120"
}
}
}
Obtener la cantidad de unidades en stock de varios productos
URL:
https://api.webered.com/stock
Compatibilidad con integraciones existentes:
https://{DOMINIO DEL SITIO WEB}/pw/api/stock?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
Se pueden paginar los resultados utilizando los siguentes parámetros:
- page: número de página. Por defecto 1 si no es proporcionado.
- page_size: cantidad de registros a incluir en el resultado. Por defecto 100 si no es proporcionado (valor máximo).
Se pueden filtrar los resultados agregando los siguientes parámetros:
- producto_codigo: se buscan los productos cuyo código coincida con este valor. Se pueden indicar varios códigos separándolos por comas. No se permiten más de 20 códigos.
- producto_activo: se buscan productos activos (1) o inactivos (0).
- producto_destacado: se buscan productos destacados (1) o no destacados (0).
- producto_nombre: se buscan productos que contengan este valor en su nombre.
- categoria_codigo: se buscan los productos que tengan asignada la categoría cuyo código coincida con este valor.
- variante1_codigo: se buscan los productos que tengan asignada la variante primaria cuyo código coincida con este valor.
- variante2_codigo: se buscan los productos que tengan asignada la variante secundaria cuyo código coincida con este valor.
- sku: se buscan los productos que en su información de stock tengan este valor de código SKU.
- ean: se buscan los productos que en su información de stock tengan este valor de código EAN.
- cantidad: se buscan los productos que en su información de stock tengan esta cantidad de unidades. Este valor se debe usar cuando el parámetro "cantidad_operador" es distinto de "entre".
- cantidad_min: cantidad mínima cuando se quiere hacer una búsqueda entre dos valores. Este valor se debe usar cuando el parámetro "cantidad_operador" es igual a "entre".
- cantidad_max: cantidad máxima cuando se quiere hacer una búsqueda entre dos valores. Este valor se debe usar cuando el parámetro "cantidad_operador" es igual a "entre".
- cantidad_operador: los operadores de comparación de cantidades son los siguientes: "menor_igual", "menor", "igual", "mayor", "mayor_igual", "entre".
- El operador "igual" es el valor por defecto si solo se envía el valor "cantidad".
- Los operadores "menor_igual", "menor", "igual", "mayor", "mayor_igual" requieren la presencia del valor "cantidad".
- El operador "entre" requiere la presencia de los valores "cantidad_min" y "cantidad_max". En este caso no se debe enviar el valor "cantidad". La búsqueda incluye ambos valores del rango.
Respuesta:
Lista de stock ordenada en primer lugar por código de producto y en segundo lugar por cantidad.
Ejemplo:
{
"result": {
"count": "8",
"total_count": "18",
"page": "2",
"page_size": "10",
"last_page": "2",
"items": [
{
"codigo": "STK-COL",
"nombre_es": "PRODUCTO CON COLOR",
"nombre_en": "",
"activo": "1",
"destacado": "1",
"variante1_codigo": "",
"variante2_codigo": "COL-BLA",
"sku": "",
"ean": "",
"cantidad": "0"
},
{
"codigo": "STK-COL",
"nombre_es": "PRODUCTO CON COLOR",
"nombre_en": "",
"activo": "1",
"destacado": "1",
"variante1_codigo": "",
"variante2_codigo": "COL-AZUL",
"sku": "",
"ean": "",
"cantidad": "3"
},
{
"codigo": "STK-TAM",
"nombre_es": "PRODUCTO CON TAMAÑO",
"nombre_en": "",
"activo": "1",
"destacado": "1",
"variante1_codigo": "TAM-MEDIANO",
"variante2_codigo": "",
"sku": "",
"ean": "",
"cantidad": "-4"
},
{
"codigo": "STK-TAM",
"nombre_es": "PRODUCTO CON TAMAÑO",
"nombre_en": "",
"activo": "1",
"destacado": "1",
"variante1_codigo": "TAM-GRANDE",
"variante2_codigo": "",
"sku": "",
"ean": "",
"cantidad": "96"
},
{
"codigo": "STK-TAM",
"nombre_es": "PRODUCTO CON TAMAÑO",
"nombre_en": "",
"activo": "1",
"destacado": "1",
"variante1_codigo": "TAM-CHICO",
"variante2_codigo": "",
"sku": "",
"ean": "",
"cantidad": "2981"
},
{
"codigo": "STK-TAM-COL",
"nombre_es": "PRODUCTO CON TAMAÑO Y CON COLOR",
"nombre_en": "",
"activo": "1",
"destacado": "1",
"variante1_codigo": "TAM-MEDIANO",
"variante2_codigo": "COL-AZUL",
"sku": "",
"ean": "",
"cantidad": "41"
},
{
"codigo": "STK-TAM-COL",
"nombre_es": "PRODUCTO CON TAMAÑO Y CON COLOR",
"nombre_en": "",
"activo": "1",
"destacado": "1",
"variante1_codigo": "TAM-CHICO",
"variante2_codigo": "COL-AZUL",
"sku": "",
"ean": "",
"cantidad": "45"
},
{
"codigo": "STK-TAM-COL",
"nombre_es": "PRODUCTO CON TAMAÑO Y CON COLOR",
"nombre_en": "",
"activo": "1",
"destacado": "1",
"variante1_codigo": "TAM-MEDIANO",
"variante2_codigo": "COL-BLA",
"sku": "med-bla",
"ean": "",
"cantidad": "71"
}
]
}
}
Se incluyen también valores relacionados con la paginación:
- count: cantidad de elementos devueltos en la página actual (contenido del objeto "items").
- total_count: cantidad total de elementos hallados sin considerar paginación.
- page: número de página correspondiente al resultado actual.
- page_size: cantidad máxima de elementos devueltos por página.
- last_page: número de la última página.
