Fecha | Versión | Descripción | Autor |
---|---|---|---|
1.0 | Creación del documento | ||
| 1.1 | Se agrega el código y nombre del depósito. Cantidad reservda |
Este servicio, permite consultar el stock disponible en cada tienda, de todo depósito en estado a la venta (OnSale) para un SKU.
- Se invoca de la siguiente manera: https://[direccion_ip]:[puerto]/stock/status - Ejemplo: https://200.100.100.100:8090/stock/status
- Se invoca vía GET.
Tener en cuenta:
- Primero se debe invocar al servicio de autenticación para obtener un token.
- Cuando se llama a cualquier servicio este token se envía como un parámetro más de la llamada en el header (x-access-token).
- Si al llamar al servicio el token expiró, se recibirá respuesta de token inválido y se deberá volver a pedir uno nuevo.
Ejemplo del JSON a enviar en el body:
{ "internalCodes": [ "GUS01" ] }
Descripción de los campos:
Importante: los campos que poseen este ícono
, son valores tipificados que deben respetar los valores expuestos por BRIDGE en sus servicios.Campo | Tipo | Descripción | Requerido | Ejemplos | Validación (código) | |
---|---|---|---|---|---|---|
internalCodes | String[] | Un listado con códigos únicos que identifican a los productos. | SI, al menos uno. | 000001 | 991: el item no existe. |
Respuesta del servicio:
{ "ack": 0, "detail": [ { "internalCode": "GUS01", "detail": [ { "storeCode": "1", "stock": 42, "reserved": 0, "locationCode": "DEP1", "locationName": "Disponible Para La Venta" }, { "storeCode": "2", "stock": 3, "reserved": 0, "locationCode": "DEP1", "locationName": "Disponible Para La Venta" }, { "storeCode": "2", "stock": 2, "reserved": 0, "locationCode": "CONSIG", "locationName": "Consignación" }, { "storeCode": "2", "stock": 1, "reserved": 0, "locationCode": "DEV", "locationName": "Devoluciones" } ] } ] }
- ack es el código de respuesta, en caso de ser un error, mirar tabla a continuación.
- message: descripción del error en caso de existir.
- colección llamada detail, que contiene el detalle por código interno del producto y tienda, depósito (código y nombre), del stock disponible en el depósito configurado para ello.
Campo | Descripción |
---|---|
internalCode | código del ítem |
detail [ ] | Lista de detalle por cada ítem |
storeCode | Código de tienda |
stock | Cantidad de unidades en stock |
reserved | Cantidad de unidades reservadas del stock |
locationCode | Código del depósito |
locationName | Nombre del depósito |
Códigos de error generales:
Código de Error | Descripción |
---|---|
0 | La operación es exitosa. |
9999 | Error desconocido |