Pedidos

Consultar todos los pedidos

Consulta una lista paginada de todos los pedidos del negocio actual.

Autenticación requerida: Este endpoint requiere autenticación Bearer Token. Usar el campo tokenCurrent obtenido del servicio de login (/login) en el header: Authorization: Bearer {tokenCurrent}

Soporta múltiples filtros para búsqueda específica y paginación para manejo eficiente de grandes volúmenes de datos.

Limitaciones plan trial: Las cuentas en periodo de prueba solo pueden ver pedidos de las últimas 24 horas.

Ejemplos de Uso

1. Consultar todos los pedidos (primera página)

GET /orders?pagination=true&limit=10&page=0
Authorization: Bearer tu_token_aqui

Consulta los primeros 10 pedidos ordenados por fecha de creación (más recientes primero).

2. Buscar pedidos en espera

GET /orders?status=Espera&limit=20
Authorization: Bearer tu_token_aqui

Filtra pedidos con estado 'Espera' para procesamiento en cocina.

3. Pedidos de una mesa específica

GET /orders?tableId=507f1f77bcf86cd799439014&pagination=true
Authorization: Bearer tu_token_aqui

Consulta todos los pedidos de una mesa específica con paginación.

4. Mis pedidos como vendedor

GET /orders?onlyMine=true&status=Entregado&limit=50
Authorization: Bearer tu_token_aqui

Filtra solo los pedidos del vendedor autenticado que han sido entregados.

5. Pedidos por rango de fechas

GET /orders?dateInit=2025-08-05T00:00:00.000Z&dateEnd=2025-08-05T23:59:59.999Z
Authorization: Bearer tu_token_aqui

Consulta pedidos creados en un rango específico de fechas.

get/orders

Request

  • Base URL
    https://api.pirpos.com
  • URL
    https://api.pirpos.com/orders
  • Auth
    HTTP bearer

Query parameters

paginationboolean

Activar paginación de resultados (cuando es true, retorna objeto con data y count)

limitinteger

Número máximo de pedidos por página (máximo 3000)

pageinteger

Número de página (inicia en 0)

status'Espera' | 'Cocina' | 'Listo' | 'Entregado' | 'Cancelado'

Filtrar por estado del pedido

statusKitchen'Espera' | 'Preparacion' | 'Listo'

Filtrar por estado en cocina

onlyMineboolean

Mostrar solo pedidos del vendedor autenticado

groupstring

Filtrar por ID de grupo de pedidos

isComplementaryboolean

Filtrar por pedidos cortesía (gratuitos)

tableIdstring

Filtrar por ID de mesa específica

productstring

Filtrar por ID de producto específico

dateInitstring date-time

Fecha inicial para filtrar pedidos

dateEndstring date-time

Fecha final para filtrar pedidos

Response

Lista de pedidos obtenida exitosamente

OR

Example response

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "business": "507f1f77bcf86cd799439012",
    "product": {
      "name": "Hamburguesa Clásica",
      "price": 15000
    },
    "table": {
      "name": "Mesa 5"
    },
    "deliveryProviderOrder": "507f1f77bcf86cd799439014",
    "group": "507f1f77bcf86cd799439015",
    "groupName": "Grupo Mesa 5",
    "seller": {
      "name": "Carlos",
      "lastName": "Pérez",
      "urlImage": "https://ejemplo.com/vendedor.jpg"
    },
    "notes": [
      "Sin cebolla",
      "Extra queso"
    ],
    "causeCancel": "Cliente canceló",
    "quantity": 2,
    "unit_price": 15000,
    "total": 30000,
    "status": "Espera",
    "statusKitchen": "Espera",
    "productsExtra": [
      {
        "product": {
          "name": "Papas fritas",
          "price": 5000
        },
        "quantity": 1
      }
    ],
    "modifiedBy": {
      "name": "Admin"
    },
    "createdOn": "2025-08-05T10:30:00.000Z",
    "modifiedOn": "2025-08-05T10:30:00.000Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.