Listar las órdenes abiertas de una mesa

GET

/tables/{tableKey}/orders

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

Devuelve las órdenes de la mesa que no están cerradas. Si la mesa no tiene órdenes abiertas, la respuesta es 200 con data vacío.

La mesa 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

tableKey

required

string format: uuid

Identificador (UUID) de la mesa.

Example

5a8e3c71-0d94-4b26-9f17-c2e6b0a4d813

Responses

200

Las órdenes abiertas de la mesa, cada una con su código, moneda, total, importe cobrado e importe a pagar. Sirve para saber qué cuentas siguen pendientes en una mesa.

• La respuesta no está paginada ni tiene un orden garantizado.
• Solo incluye órdenes que no están cerradas. Una mesa sin órdenes abiertas responde 200 con data vacío.
• paid_amount es lo cobrado hasta el momento de la consulta.
• Los importes son números JSON, no cadenas de texto.

object

data

required

Array<object>

object

uuid

required

Identificador de la orden.

string format: uuid

order_code

required

Código de la orden.

string

currency

required

object

uuid

required

Identificador de la moneda.

string format: uuid

name

required

Nombre de la moneda.

string

symbol

required

Símbolo de la moneda.

string

separator

required

Separador de la moneda, tal como está registrado en IDPOS.

string

total

required

Importe total de la orden.

number

paid_amount

required

Importe cobrado hasta el momento.

number

payable_amount

required

Importe a pagar de la orden.

number

Examples

{
  "data": [
    {
      "uuid": "0f8d1c52-7a3e-4b19-9c64-2d5e8a1b7f30",
      "order_code": "A-0147",
      "currency": {
        "uuid": "719b61f7-0e77-4e7c-8e78-7a9b51791c29",
        "name": "PEN",
        "symbol": "S/",
        "separator": ","
      },
      "total": 45.5,
      "paid_amount": 0,
      "payable_amount": 45.5
    }
  ]
}

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