> ## Documentation Index > Fetch the complete documentation index at: https://docs.riqra.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar pedidos > Lista todos los pedidos. ## OpenAPI ````yaml /api/openapi.json get /orders openapi: 3.1.0 info: title: Riqra API version: '1.0' contact: email: soporte@riqra.com url: https://www.riqra.com/ name: Riqra Support description: >- Usando nuestra API puedes integrar tu ERP o tu sistema actual de administración con [Riqra](https://www.riqra.com/). servers: - url: https://sandbox.api.riqra.com description: Sandbox - description: Producción url: https://api.riqra.com security: - API Key: [] tags: - name: Almacenes - name: Banners - name: Categorías - name: Clientes - name: Clientes - Direcciones - name: Cobertura - name: Comercio - name: Cupones - name: Inventario - name: Líneas de Crédito - name: Lista de Precios - name: Lista de Precios - Precios - name: Marcas - name: Pedidos - name: Productos - name: Productos Sugeridos - name: Promociones - name: Stock - name: Subcategorías - name: Variantes paths: /orders: get: tags: - Pedidos summary: Listar pedidos description: Lista todos los pedidos. operationId: listOrders parameters: - name: limit in: query schema: type: integer default: 10 maximum: 20 description: Número de elementos para retornar. - schema: type: integer default: 1 in: query name: page description: Número de página para retornar. - name: from in: query schema: type: string examples: - '2023-09-28T05:00:00Z' description: >- 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. - name: to in: query schema: type: string examples: - '2023-09-30T05:00:00Z' description: >- 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. - name: status in: query schema: type: string description: El slug del estado de los pedidos. - name: deliveryDate in: query schema: type: string examples: - '2023-09-28' description: >- 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. - name: expand in: query schema: type: string examples: - customer,shippingAddress,billingAddress description: >- 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. responses: '200': description: OK content: application/json: schema: type: object properties: items: type: array items: $ref: '#/components/schemas/ListOrders' pagination: $ref: '#/components/schemas/Pagination' components: schemas: ListOrders: type: object properties: id: type: integer description: El ID del pedido. code: type: string description: El código del pedido. erpCode: type: - string - 'null' description: El código ERP de integración. status: type: string description: El estado del pedido. vendor: type: string description: El vendor donde esta órden fue generada. createdAt: type: string format: date-time description: La fecha de creación del pedido. total: type: string description: El total del pedido. finalTotal: type: string description: >- Total del pedido incluyendo la percepción. * Sólo aplica a Perú, si eres un agente de percepción y tienes la funcionalidad activada, sino esta propiedad siempre será igual que `total` y es seguro continuar usándola. extraFields: type: - object - 'null' customer: type: - object - 'null' description: >- Información del cliente. Solo aparecerá si la relación fue expandida (ver query param `expand`). properties: id: type: number description: El ID del cliente. firstName: type: - string - 'null' description: El nombre del cliente. lastName: type: - string - 'null' description: El apellido del cliente. Pagination: type: object properties: page: type: integer description: Número de la página actual. pages: type: integer description: Número total de páginas. total: type: integer description: Cantidad total de elementos. hasPrevPage: type: boolean description: Indica si existe una página previa. hasNextPage: type: boolean description: Indica si existe una página siguiente. securitySchemes: API Key: name: api-key type: apiKey in: header description: >- Todas las llamadas al API tienen que contener este header junto a la clave para poder autenticar y autorizar al cliente. ````