Listar los productos de una orden

GET

/orders/{orderKey}/products

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

Devuelve los productos de la orden. Si la orden no tiene productos, la respuesta es 404 y el cuerpo contiene data vacío.

La orden debe pertenecer a una tienda a la que da acceso el token. Si pertenece a otra tienda o no existe, la respuesta es 403.

Authorizations

OpenApiKey
OpenApiToken

Parameters

Path Parameters

orderKey

required

string format: uuid

Identificador (UUID) de la orden.

Example

0f8d1c52-7a3e-4b19-9c64-2d5e8a1b7f30

Responses

200

Los productos de la orden, cada uno con su SKU, nombre, cantidad e importe total de la línea. Sirve para ver el detalle de lo que contiene una orden.

La respuesta no está paginada ni tiene un orden garantizado.
Una orden sin productos no responde 200: responde 404 con data vacío.
quantity y total_amount son números JSON, no cadenas de texto.

object

data

required

Array<object>

object

uuid

required

Identificador del producto dentro de la orden.

string format: uuid

sku

required

SKU del producto.

string

name

required

Nombre del producto.

string

total_amount

required

Importe total de la línea.

number

quantity

required

Cantidad.

number

Examples

{
  "data": [
    {
      "uuid": "d2f6a8b1-47c3-4e09-85a2-1b7c9e3d0f56",
      "sku": "BEB-0012",
      "name": "Limonada frozen",
      "total_amount": 14,
      "quantity": 2
    },
    {
      "uuid": "91c4e7a3-6b2d-4f58-a0e9-3d5b8c1f7a24",
      "sku": "COM-0034",
      "name": "Lomo saltado",
      "total_amount": 31.5,
      "quantity": 1
    }
  ]
}

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 orden indicada en la ruta no pertenece a una tienda del token. La respuesta es la misma para una orden de otra tienda y para una orden 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 orden solicitada"
  }
}

404

La orden pertenece al token, pero no tiene productos. El cuerpo contiene data vacío.

object

data

required

Array<object>

object

uuid

required

Identificador del producto dentro de la orden.

string format: uuid

sku

required

SKU del producto.

string

name

required

Nombre del producto.

string

total_amount

required

Importe total de la línea.

number

quantity

required

Cantidad.

number

Examples

{
  "data": []
}