Saltar al contenido principal
GET
/
orders
Listar pedidos
curl --request GET \
  --url https://sandbox.api.riqra.com/orders \
  --header 'api-key: <api-key>'
{
  "items": [
    {
      "id": 123,
      "code": "<string>",
      "erpCode": "<string>",
      "status": "<string>",
      "vendor": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "total": "<string>",
      "finalTotal": "<string>",
      "extraFields": {},
      "customer": {
        "id": 123,
        "firstName": "<string>",
        "lastName": "<string>"
      }
    }
  ],
  "pagination": {
    "page": 123,
    "pages": 123,
    "total": 123,
    "hasPrevPage": true,
    "hasNextPage": true
  }
}

Authorizations

​
api-key
string
header
required

Todas las llamadas al API tienen que contener este header junto a la clave para poder autenticar y autorizar al cliente.

Query Parameters

​
limit
integer
default:10

Número de elementos para retornar.

Rango requerido: x <= 20
​
page
integer
default:1

Número de página para retornar.

​
from
string

Este parámetro representa la fecha de inicio para filtrar por la fecha de creación de los pedidos.

Debe utilizarse en conjunto con el parámetro to para establecer un rango que permita filtrar los pedidos cuya fecha de creación se encuentre dentro de ese intervalo.

Este parámetro es inclusivo, lo que significa que la fecha que se ingrese será considerada en el intervalo.

La fecha debe estar en formato ISO-8601 y se debe incluir información explicita sobre la zona horaria, si no se incluye se asumirá que se está usando UTC(Tiempo Universal Coordinado).

El formato es el siguiente

  • YYYY-MM-DDTHH:mm:sszz

YYYY-MM-DD representa el año, el mes y el día.

T es un separador que indica el inicio de la parte de la hora y se escribe tal cual.

HH:mm:ss representa la hora (en formato de 24 horas), los minutos y los segundos.

zz es el sufijo que representa la zona horaria, puede ser Z para UTC o ±HH o ±HH:mm para las demás zonas horarias.

Ejemplo:

Si se desea consultar los pedidos en la zona horaria de Perú desde el 28 de setiembre, se puede consultar con

  • 2023-09-28T00:00:00-05
  • 2023-09-28T05:00:00Z

Ambas son equivalentes dado que la diferencia horaria de Perú respecto a UTC es -5.

​
to
string

Este parámetro representa la fecha de finalización para filtrar por la fecha de creación de los pedidos.

Debe utilizarse en conjunto con el parámetro from para establecer un rango que permita filtrar los pedidos cuya fecha de creación se encuentre dentro de ese intervalo.

Este parámetro es inclusivo, lo que significa que la fecha que se ingrese será considerada en el intervalo.

La fecha debe estar en formato ISO-8601 y se debe incluir información explicita sobre la zona horaria, si no se incluye se asumirá que se está usando UTC(Tiempo Universal Coordinado).

El formato es el siguiente

  • YYYY-MM-DDTHH:mm:sszz

YYYY-MM-DD representa el año, el mes y el día.

T es un separador que indica el inicio de la parte de la hora y se escribe tal cual.

HH:mm:ss representa la hora (en formato de 24 horas), los minutos y los segundos.

zz es el sufijo que representa la zona horaria, puede ser Z para UTC o ±HH o ±HH:mm para las demás zonas horarias.

Ejemplo:

Si se desea consultar los pedidos en la zona horaria de Perú hasta el 30 de setiembre, se puede consultar con

  • 2023-09-30T00:00:00-05
  • 2023-09-30T05:00:00Z

Ambas son equivalentes dado que la diferencia horaria de Perú respecto a UTC es -5.

​
status
string

El slug del estado de los pedidos.

​
deliveryDate
string

Filtra todos los pedidos cuya fecha de entrega coincida con el valor indicado.

La fecha debe tener el formato YYYY-MM-DD.

Si se usa este parámetro, los parámetros from y to serán omitidos.

Este parámetro usa la zona horaria del comercio, no del cliente.

​
expand
string

Este parámetro está en fase ALPHA, es decir, puede sufir cambios drásticos, así que debe ser usado con precaución. Expande relaciones del pedido, por ejemplo, si en la respuesta solo aparece customerId, expandiendo la relación customer, aparecerá un nuevo campo customer que incluya el id y fullName. Acepta una lista de relaciones a expandir en una cadena de texto separada por comas. Considerar expandir solo las relaciones que se necesiten.

Response

200 - application/json

OK

​
items
object[]
​
pagination
object