Consultar el stock de artículos por SKU

GET

/stores/{storeKey}/items/stock

Servidor de la API. El valor de host lo proporciona IDBI.

Devuelve el stock de cada SKU solicitado en un almacén de la tienda. Un SKU que no existe en la tienda o no tiene registro en el almacén se devuelve con found en false y stock en 0. all_in_stock es true solo si todos los SKU existen y tienen stock mayor que cero. El SKU se compara tal como lo envía, distinguiendo mayúsculas de minúsculas.

Envíe cada SKU como un elemento repetido del arreglo, por ejemplo skus[]=BEB-0012&skus[]=COM-0034.

Authorizations

OpenApiKey
OpenApiToken

Parameters

Path Parameters

storeKey

required

string format: uuid

Identificador (UUID) de la tienda.

Example

2b7d9e40-c1a3-4f58-8e06-5a4d3c7b9f12

Query Parameters

skus[]

required

Array<string>

>= 1 items

SKU a consultar. Se debe enviar al menos uno.

Example

?skus%5B%5D=BEB-0012&skus%5B%5D=COM-0034

warehouse_uuid

required

string format: uuid

Identificador (UUID) del almacén. Debe pertenecer a la tienda: un identificador que no corresponde a ningún almacén responde 422 y el de un almacén de otra tienda responde 400.

Example

c8f1d5a2-69e0-4b37-a4c6-2e0b7d9f3a58

Responses

200

El stock de cada SKU solicitado en el almacén indicado, más un indicador de si todos tienen existencias. Sirve para validar la disponibilidad de artículos desde su sistema.

items trae un elemento por SKU, en el orden de la petición.
Un SKU que no existe en la tienda o no tiene registro en el almacén no falla: llega con found en false y stock en 0, sin item_uuid ni name.
all_in_stock es true solo si todos los SKU existen y tienen stock mayor que cero.
El SKU se compara tal como lo envía, distinguiendo mayúsculas de minúsculas.
El stock es el del momento de la consulta.

object

data

required

object

warehouse_uuid

required

Identificador del almacén consultado.

string format: uuid

all_in_stock

required

Es true solo si todos los SKU existen y tienen stock mayor que cero.

boolean

items

required

Un elemento por cada SKU solicitado, en el orden de la petición.

Array<object>

object

sku

required

SKU consultado.

string

found

required

Indica si el SKU existe en la tienda y tiene registro en el almacén.

boolean

item_uuid

Identificador del artículo. Solo se incluye cuando found es true.

string format: uuid

name

Nombre del artículo. Solo se incluye cuando found es true.

string

stock

required

Cantidad disponible en el almacén. Es 0 cuando found es false.

number

in_stock

required

Es true cuando stock es mayor que cero.

boolean

Examples

{
  "data": {
    "warehouse_uuid": "c8f1d5a2-69e0-4b37-a4c6-2e0b7d9f3a58",
    "all_in_stock": false,
    "items": [
      {
        "sku": "BEB-0012",
        "found": true,
        "item_uuid": "4e7a1c93-0b5d-4f28-96a3-d1c8e2b5a074",
        "name": "Limonada frozen",
        "stock": 18,
        "in_stock": true
      },
      {
        "sku": "COM-0034",
        "found": false,
        "stock": 0,
        "in_stock": false
      }
    ]
  }
}

400

El almacén no pertenece a la tienda.

Formato de error con error.message.

object

error

required

Detalle del error, con su mensaje.

object

message

required

Descripción del error.

string

Examples

{
  "error": {
    "message": "El almacén no pertenece a esta tienda"
  }
}

401

Credenciales ausentes, inválidas, deshabilitadas o vencidas. El campo error.description indica el motivo.

Formato de error de la autenticación y del control de acceso del token.

object

error

required

Detalle del error, con su código, su mensaje y su descripción.

object

code

required

Siempre es 0.

integer

message

required

Mensaje del error.

string

description

required

Detalle del error, cuando existe.

string | null

Examples

Falta una de las cabeceras

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token es obligatorio"
  }
}

Token que no corresponde a la clave

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token es inválido"
  }
}

Clave inexistente

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token no fue encontrado"
  }
}

Token deshabilitado

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token está deshabilitado"
  }
}

Token vencido

{
  "error": {
    "code": 0,
    "message": "No autorizado",
    "description": "El token expiró"
  }
}

403

La tienda indicada en la ruta no pertenece al token. La respuesta es la misma para una tienda ajena y para una tienda inexistente.

Formato de error de la autenticación y del control de acceso del token.

object

error

required

Detalle del error, con su código, su mensaje y su descripción.

object

code

required

Siempre es 0.

integer

message

required

Mensaje del error.

string

description

required

Detalle del error, cuando existe.

string | null

Examples

{
  "error": {
    "code": 0,
    "message": "Acceso denegado",
    "description": "El token no tiene acceso a la tienda solicitada"
  }
}

422

Los datos enviados no cumplen las reglas de validación.

Formato de error cuando los datos enviados no superan la validación.

object

message

required

Mensaje general de validación.

string

errors

required

Mensajes de error agrupados por nombre de campo.

object

key

additional properties

Array<string>

Examples

{
  "message": "Uno o más de los datos que has ingresado no cumplen con los requisitos mínimos.",
  "errors": {
    "amount": [
      "El campo amount es obligatorio."
    ]
  }
}