Consulta de Pedidos

Listagem de Pedidos "Não Lidos" por Loja

Este endpoint é utilizado para listar os pedidos não lidos associados a uma loja específica. Geralmente, esta lista é utilizada para notificar a loja sobre novos pedidos.

GET

/orders

Parâmetros da Requisição (Query Parameters)

Parâmetro	Tipo	Obrigatório	Descrição
filter[store_ids]	String	✅	IDs das lojas cujos pedidos serão listados. Deve ser uma lista de IDs separadas por vírgula (,).

Resposta de Sucesso (Status Code 200)

O retorno é um array de objetos de pedido na chave data, contendo as informações de resumo dos pedidos não lidos (is_read: false).

{
  "data": [
    {
      "order_id": 24339137,
      "created_at": "2025-05-07 14:52:20",
      "is_ready": false,
      "is_read": false,
      "is_cancelled": false,
      "is_in_separation": false,
      "is_delivered": false,
      "user_name": "henrique",
      "is_aiqentrega_delivery": false,
      "order_is_pickup": true,
      "is_scheduled": false,
      "store_id": 53880,
      "store_name": "loja catalogo qa luiz",
      "pickup_at": "2025-12-16 15:22:00"
    },
    {
      "order_id": 24339817,
      "created_at": "2025-09-09 10:00:00",
      "is_ready": false,
      "is_read": false,
      "is_cancelled": false,
      "is_in_separation": false,
      "is_delivered": false,
      "user_name": "henrique",
      "is_aiqentrega_delivery": false,
      "order_is_pickup": false,
      "is_scheduled": false,
      "store_id": 53880,
      "store_name": "loja catalogo qa luiz",
      "order_delivery_time": "60 - 90"
    },
    {
      "order_id": 24340249,
      "created_at": "2025-11-14 11:40:25",
      "is_ready": false,
      "is_read": false,
      "is_cancelled": false,
      "is_in_separation": false,
      "is_delivered": false,
      "user_name": "henrique",
      "is_aiqentrega_delivery": false,
      "order_is_pickup": false,
      "is_scheduled": true,
      "store_id": 53880,
      "store_name": "loja catálogo henrique",
      "scheduled_dates": {
        "start_date": "2025-11-14 13:00:00",
        "end_date": "2025-11-14 15:00:00"
      }
    }
  ]
}

Detalhamento dos Campos de Resposta

Campo	Descrição
order_id	ID único do pedido.
created_at	Data e hora da criação do pedido.
is_ready	Indica se o pedido está pronto para ser entregue/retirado.
is_read	Indica se o pedido foi lido/visualizado. O foco deste endpoint é em pedidos com is_read: false.
is_cancelled	Indica se o pedido foi cancelado.
is_in_separation	Indica se o pedido está em separação. (Utilizado para itens de catálogo)
is_delivered	Indica se o pedido foi entregue.
user_name	Nome do cliente.
is_aiqentrega_delivery	Indica se a entrega será realizada pela logística do Aiqfome.
order_is_pickup	Indica se o pedido é para retirada na loja (true) ou entrega (false).
is_scheduled	Indica se o pedido é agendado (true).
store_id	ID da loja.
store_name	Nome da loja.
order_delivery_time	Estimativa de tempo de entrega (Ex: "60 - 90" minutos). (Pedidos não agendados)
pickup_at	Hora agendada para retirada. (Pedidos de retirada)
scheduled_dates	Objeto contendo o intervalo de tempo de entrega agendado (start_date e end_date). (Pedidos de entrega agendada)

Listagem de Todos os Pedidos por Loja

Este endpoint é utilizado para buscar e listar pedidos da loja, permitindo filtros por ID de loja, ID de pedido específico, ID de entrega ou e-mail do usuário. É ideal para consultas de histórico ou pedidos já processados.

GET

/orders/search

Parâmetros da Requisição (Query Parameters)

A busca é feita através de query parameters. Pelo menos um filtro é geralmente obrigatório para limitar a consulta

Parâmetro	Descrição
filter[store_id]	ID da loja (número inteiro).
filter[order_id]	ID único de um pedido específico.
filter[delivery_id]	ID da entrega associada ao pedido. Utilizado apenas para pedidos com Aiqentrega.
filter[user_email]	E-mail do usuário/cliente.
filter[order_ids]	Lista de IDs de pedidos separadas por vírgula (,).

Resposta de Sucesso (Status Code 200)

O retorno é um array de objetos de pedido na chave data. A estrutura do payload é a mesma da listagem de pedidos, mas inclui todos os status.

{
  "data": [
    {
      "order_id": 24340161,
      "created_at": "2025-11-03 11:30:41",
      "is_ready": false,
      "is_read": false,
      "is_cancelled": true,
      "is_in_separation": false,
      "is_delivered": false,
      "user_name": "henrique",
      "is_aiqentrega_delivery": false,
      "order_is_pickup": false,
      "is_scheduled": true,
      "store_id": 54044,
      "store_name": "loja catálogo henrique",
      "scheduled_dates": {
        "start_date": "2025-11-03 12:00:00",
        "end_date": "2025-11-03 14:00:00"
      }
    },
    {
      "order_id": 24340299,
      "created_at": "2025-12-09 17:46:15",
      "is_ready": false,
      "is_read": false,
      "is_cancelled": false,
      "is_in_separation": false,
      "is_delivered": false,
      "user_name": "henrique",
      "is_aiqentrega_delivery": false,
      "order_is_pickup": false,
      "is_scheduled": false,
      "store_id": 54044,
      "store_name": "loja catálogo henrique",
      "order_delivery_time": "20 - 40"
    },
    {
      "order_id": 24340305,
      "created_at": "2025-12-16 10:32:59",
      "is_ready": true,
      "is_read": true,
      "is_cancelled": false,
      "is_in_separation": false,
      "is_delivered": false,
      "user_name": "henrique",
      "is_aiqentrega_delivery": true,
      "order_is_pickup": true,
      "is_scheduled": false,
      "store_id": 54044,
      "store_name": "loja catálogo henrique",
      "pickup_at": "2025-12-16 10:42:00"
    }
  ]
}

Detalhamento dos Campos de Resposta

Campo	Descrição
order_id	ID único do pedido.
created_at	Data e hora da criação do pedido.
is_ready	Indica se o pedido está pronto para ser entregue/retirado.
is_read	Indica se o pedido foi lido/visualizado pelo sistema da loja.
is_cancelled	Indica se o pedido foi cancelado.
is_in_separation	Indica se o pedido está em separação. (Utilizado para itens de catálogo)
is_delivered	Indica se o pedido foi entregue.
user_name	Nome do cliente.
is_aiqentrega_delivery	Indica se a entrega será realizada pela logística do Aiqfome.
order_is_pickup	Indica se o pedido é para retirada na loja (true) ou entrega (false).
is_scheduled	Indica se o pedido é agendado (true).
store_id	ID da loja.
store_name	Nome da loja.
scheduled_dates	Intervalo de tempo de entrega agendado (Pedidos de entrega agendada).
order_delivery_time	Estimativa de tempo de entrega (Pedidos não agendados).
pickup_at	Hora agendada para retirada (Pedidos de retirada).

Listagem de Pedidos em Aberto

Este endpoint é utilizado para listar pedidos que ainda não atingiram um estado final ou de processamento avançado. Ele permite filtrar se o pedido foi lido ou não, excluindo automaticamente pedidos que já estão prontos, em separação ou cancelados, independentemente do filtro is_read.

GET

/orders/open

Regra de Retorno: O endpoint /orders/open garante que nunca retornará pedidos que já estejam em estados considerados avançados ou concluídos. Os pedidos que não são retornados são aqueles onde:

• is_ready é true (Pronto)
• is_in_separation é true (Em Preparo)
• is_cancelled é true (Cancelado)

Este endpoint foca em pedidos que ainda precisam ser aceitos, confirmados ou que estão em status inicial.

Parâmetros da Requisição (Query Parameters)

Parâmetro	Descrição
filter[store_ids]	IDs das lojas cujos pedidos serão listados. Deve ser uma lista de IDs separadas por vírgula (,).
filter[is_read]	Filtra pedidos lidos (1) ou não lidos (0). Valores: 1 (Lido) ou 0 (Não Lido).

Resposta de Sucesso (Status Code 200)

O retorno é um array de objetos de pedido na chave data.

{
  "data": [
    {
      "order_id": 24340249,
      "created_at": "2025-11-14 11:40:25",
      "is_ready": false,
      "is_read": false,
      "is_cancelled": false,
      "is_in_separation": false,
      "is_delivered": false,
      "user_name": "henrique",
      "is_aiqentrega_delivery": false,
      "order_is_pickup": false,
      "is_scheduled": true,
      "store_id": 54044,
      "store_name": "loja catálogo henrique",
      "scheduled_dates": {
        "start_date": "2025-11-14 13:00:00",
        "end_date": "2025-11-14 15:00:00"
      }
    },
    {
      "order_id": 24340311,
      "created_at": "2025-12-16 11:13:33",
      "is_ready": false,
      "is_read": true,
      "is_cancelled": false,
      "is_in_separation": false,
      "is_delivered": false,
      "user_name": "henrique",
      "is_aiqentrega_delivery": false,
      "order_is_pickup": false,
      "is_scheduled": false,
      "store_id": 54044,
      "store_name": "loja catálogo henrique",
      "order_delivery_time": "20 - 40"
    }
  ]
}

Detalhamento dos Campos de Resposta

Campo	Descrição
order_id	ID único do pedido.
created_at	Data e hora da criação do pedido.
is_ready	Indica se o pedido está pronto (será sempre false neste endpoint, devido à regra de filtragem).
is_read	Indica se o pedido foi lido/visualizado pelo sistema da loja.
is_cancelled	Indica se o pedido foi cancelado (será sempre false neste endpoint, devido à regra de filtragem).
is_in_separation	Indica se o pedido está em separação/preparo (será sempre false neste endpoint, devido à regra de filtragem).
is_delivered	Indica se o pedido foi entregue (será sempre false neste endpoint).
user_name	Nome do cliente.
is_aiqentrega_delivery	Indica se a entrega será realizada pela logística do Aiqfome.
order_is_pickup	Indica se o pedido é para retirada na loja.
is_scheduled	Indica se o pedido é agendado.
store_id	ID da loja.
store_name	Nome da loja.
scheduled_dates	Intervalo de tempo de entrega agendado (Pedidos agendados).
order_delivery_time	Estimativa de tempo de entrega (Pedidos não agendados).

Listagem de Pedidos Cancelados

Este endpoint é utilizado para listar todos os pedidos que foram cancelados, permitindo a filtragem por loja e ID do pedido, e retornando detalhes específicos do evento de cancelamento.

GET

/orders/cancelled

Parâmetros da Requisição (Query Parameters)

Parâmetro	Obrigatório	Descrição
filter[store_ids]	✅	IDs das lojas cujos pedidos cancelados serão listados. Deve ser uma lista de IDs separadas por vírgula (,).
filter[order_id]	❌	Filtra um pedido cancelado específico pelo seu ID.

Resposta de Sucesso (Status Code 200)

O retorno é um array de objetos de pedido cancelado na chave data.

{
  "data": [
    {
      "order_id": 24340305,
      "store_id": 54044,
      "cancelled_at": "2025-12-16 10:35:30",
      "reason": "O restaurante teve problemas internos",
      "cancelled_by": "aiq-god"
    }
  ]
}

Detalhamento dos Campos de Resposta

Campo	Descrição
order_id	ID único do pedido cancelado.
store_id	ID da loja à qual o pedido pertencia.
cancelled_at	Data e hora exata em que o cancelamento foi registrado (Formato: YYYY-MM-DD HH:MM:SS).
reason	A descrição ou o motivo do cancelamento.
cancelled_by	A entidade ou sistema que iniciou o cancelamento (Ex: "aiq-god", "customer", "store").

Detalhes Completos do Pedido

Este endpoint é utilizado para obter todos os detalhes de um pedido específico pelo seu ID. O retorno inclui informações de status, itens, cliente, endereço de entrega, pagamento e timeline (histórico de status).

GET

/orders/{order_id}

Parâmetros da URL

Parâmetro	Obrigatório	Descrição
order_id (na URL)	✅	ID único do pedido que se deseja consultar.

---

Payload Detalhes Completos do Pedido de Catálogo

{
  "data": {
    "id": 24340179,
    "delivery_time": null,
    "created_at": "2025-11-05 16:07:43",
    "is_ready": true,
    "is_read": true,
    "is_cancelled": true,
    "is_in_separation": true,
    "is_delivered": false,
    "order_observations": "",
    "is_aiqentrega_delivery": false,
    "is_pickup": false,
    "pickup_at": null,
    "coupon_hash": null,
    "user_rating_value": null,
    "is_scheduled": true,
    "scheduled_dates": {
      "start_date": "2025-11-10 09:00:00",
      "end_date": "2025-11-10 11:00:00"
    },
    "items": [
      {
        "id": "fa6a5fa9-042b-3f04-b634-f8477f2e8edd",
        "order_item_id": 42571859,
        "name": "coca 2.5l",
        "replacement_type": 0,
        "status": 1,
        "sku": "f4dd141f-4d9b-4db5-8c0b-e10ffd7f897d",
        "category_name": "outros",
        "size": "Unidade",
        "unit_value": 12,
        "promotional_value": null,
        "quantity": 2,
        "discount_tax": null,
        "description": "coca 2.5l",
        "observations": "",
        "unit_packing_fee": "0.00",
        "order_mandatory_items": [],
        "order_additional_items": [],
        "order_item_subitems": []
      }
    ],
    "cancelled_items": [],
    "replaced_items": [],
    "user": {
      "uuid": "55554",
      "name": "Henrique",
      "surname": "Teste",
      "mobile_phone": "(31) 9-9988-7766",
      "phone_number": "(31) 9-9988-7766",
      "email": "henrique@aiqfome.com",
      "order_count": 11,
      "document_receipt": "015.638.986-08",
      "address": {
        "street_name": "Avenida Brasil",
        "number": "5242-5",
        "complement": "",
        "reference": "",
        "phone": "(31) 9-3265-656",
        "mobile_phone": null,
        "neighborhood_name": "Alto dos Ipês",
        "city_name": "Maringá",
        "state_uf": "PR",
        "ibge_code": "4115200",
        "zip_code": "87015-280",
        "latitude": -23.421,
        "longitude": -51.933056
      }
    },
    "payment_method": {
      "id": 121,
      "name": "Visa Crédito",
      "subtotal": "24.00",
      "delivery_tax": "30.00",
      "total_packing_fee": 0,
      "change": 0,
      "coupon_value": "0.00",
      "pre_paid": false,
      "service_fee": {
        "store": 0,
        "aiq": 0,
        "total": 0
      },
      "total_cancelled_replaced": 0,
      "original_subtotal": 24,
      "total": 54,
      "taxable_total": 54
    },
    "store": {
      "id": 54044,
      "name": "loja catálogo",
      "phones": "(31) 9876-9999",
      "preparation_time": 10
    },
    "timeline": {
      "created_at": "2025-11-05 16:07:43",
      "read_at": "2025-11-07 10:26:23",
      "cancelled_at": "2025-11-07 10:26:23",
      "ready_at": "2025-11-07 10:25:45",
      "timezone": "America/Fortaleza"
    },
    "aiqentrega": {
      "ride_id": null,
      "call_at": null,
      "current_status": null,
      "delivered_at": null,
      "last_status": null,
      "last_status_at": null,
      "driver_name": null,
      "driver_phone": null
    }
  }
}

Payload Detalhes Completos do Pedido de Cardápio

{
  "data": {
    "id": 24340321,
    "delivery_time": "40 - 60",
    "created_at": "2025-12-16 15:10:53",
    "is_ready": false,
    "is_read": false,
    "is_cancelled": false,
    "is_in_separation": false,
    "is_delivered": false,
    "order_observations": "",
    "is_aiqentrega_delivery": false,
    "is_pickup": true,
    "pickup_at": "2025-12-16 15:40:00",
    "coupon_hash": null,
    "user_rating_value": null,
    "is_scheduled": false,
    "scheduled_dates": null,
    "items": [
      {
        "id": "39536367-4042-329b-8e57-c4c4ccc8f9a4",
        "order_item_id": 42572242,
        "name": "Pizza do Chef (Em Oferta)",
        "replacement_type": 0,
        "status": 1,
        "sku": "PZ0001G",
        "category_name": "pizzas gourmet",
        "size": "G",
        "unit_value": 50,
        "promotional_value": null,
        "quantity": 3,
        "discount_tax": null,
        "description": "Calabresa, bacon, cebola e toque de pimenta.",
        "observations": "",
        "unit_packing_fee": "0.50",
        "order_mandatory_items": [
          {
            "id": 40513822,
            "group": "escolha a borda",
            "name": "Borda de Queijo (+8)",
            "value": 8,
            "sku": "BORDA_QUEIJO",
            "quantity": 1
          },
          {
            "id": 40513823,
            "group": "escolha a bebida updated",
            "name": "Coca-Cola 600ml updated",
            "value": 17.49,
            "sku": "COCA600-updated",
            "quantity": 1
          },
          {
            "id": 40513824,
            "group": "escolha a bebida updated",
            "name": "Coca-Cola 600ml updated",
            "value": 17.49,
            "sku": "COCA600-updated",
            "quantity": 1
          },
          {
            "id": 40513825,
            "group": "tipo de base",
            "name": "Molho de Tomate Tradicional",
            "value": 0,
            "sku": "BASE_TRAD",
            "quantity": 1
          },
          {
            "id": 40513826,
            "group": "molho grátis",
            "name": "Maionese Artesanal",
            "value": 0,
            "sku": "MOLHO_MAYO",
            "quantity": 1
          }
        ],
        "order_additional_items": [
          {
            "id": 10357349,
            "name": "Azeitona Extra",
            "value": 2,
            "sku": "ADD_AZEI"
          }
        ],
        "order_item_subitems": []
      }
    ],
    "cancelled_items": [],
    "replaced_items": [],
    "user": {
      "uuid": "55554",
      "name": "Henrique",
      "surname": "Teste",
      "mobile_phone": "(31) 9-9988-7777",
      "phone_number": "(31) 9-9988-7777",
      "email": "henrique@aiqfome.com",
      "order_count": 19,
      "document_receipt": null,
      "address": null
    },
    "payment_method": {
      "id": 123,
      "name": "Dinheiro",
      "subtotal": "286.44",
      "delivery_tax": "0.00",
      "total_packing_fee": 1.5,
      "change": 300,
      "coupon_value": "0.00",
      "pre_paid": false,
      "service_fee": {
        "store": 0,
        "aiq": 0,
        "total": 0
      },
      "total_cancelled_replaced": 0,
      "original_subtotal": 286.44,
      "total": 286.44,
      "taxable_total": 286.44
    },
    "store": {
      "id": 53852,
      "name": "Loja Cardápio",
      "phones": "(99) 9999-9999",
      "preparation_time": 30
    },
    "timeline": {
      "created_at": "2025-12-16 15:10:53",
      "read_at": null,
      "cancelled_at": null,
      "ready_at": null,
      "timezone": "America/Fortaleza"
    },
    "aiqentrega": {
      "ride_id": null,
      "call_at": null,
      "current_status": null,
      "delivered_at": null,
      "last_status": null,
      "last_status_at": null,
      "driver_name": null,
      "driver_phone": null
    }
  }
}

Payload Detalhes Completos do Pedido de Catálogo com item cancelado

{
  "data": {
    "id": 68670199,
    "delivery_time": "30 - 60",
    "created_at": "2026-01-05 10:58:42",
    "is_ready": true,
    "is_read": true,
    "is_cancelled": false,
    "is_in_separation": true,
    "is_delivered": true,
    "order_observations": "",
    "is_aiqentrega_delivery": false,
    "is_pickup": false,
    "pickup_at": null,
    "coupon_hash": null,
    "user_rating_value": null,
    "is_scheduled": false,
    "scheduled_dates": null,
    "items": [
      {
        "id": null,
        "order_item_id": 118069405,
        "name": "item",
        "replacement_type": 1,
        "status": 1,
        "sku": "SKU-CATALOGO-ERRO-MAX-100",
        "category_name": "",
        "size": "",
        "unit_value": 10,
        "promotional_value": null,
        "quantity": 1,
        "discount_tax": null,
        "description": "item description",
        "observations": "",
        "unit_packing_fee": "0.00",
        "order_mandatory_items": [],
        "order_additional_items": [],
        "order_item_subitems": []
      }
    ],
    "cancelled_items": [
      {
        "id": null,
        "order_item_id": 118069404,
        "name": "item",
        "replacement_type": 1,
        "status": 3,
        "sku": "SKU-CATALOGO-ERRO-MAX-100",
        "category_name": "",
        "size": "",
        "unit_value": 10,
        "promotional_value": null,
        "quantity": 1,
        "discount_tax": null,
        "description": "item description",
        "observations": "",
        "unit_packing_fee": "0.00",
        "order_mandatory_items": [],
        "order_additional_items": [],
        "order_item_subitems": []
      }
    ],
    "replaced_items": [],
    "shipment_status": {
      "latest": null,
      "logs": []
    },
    "user": {
      "uuid": "613d3a07-a7ee-11ed-9de5-02c11a0dd08c",
      "name": "luiz",
      "surname": "do aiq",
      "mobile_phone": "(61) 9-9953-7682",
      "phone_number": "(61) 9-9953-7682",
      "email": "luiz.silva@aiqfome.com",
      "order_count": 14,
      "document_receipt": null,
      "address": {
        "street_name": "",
        "number": "",
        "complement": "",
        "reference": null,
        "phone": null,
        "mobile_phone": null,
        "neighborhood_name": null,
        "city_name": "Maringá",
        "state_uf": "PR",
        "ibge_code": "4115200",
        "zip_code": null,
        "latitude": null,
        "longitude": null
      }
    },
    "payment_method": {
      "id": 0,
      "name": "Pagamento Online",
      "subtotal": "10.00",
      "delivery_tax": "0.00",
      "total_packing_fee": 0,
      "change": 0,
      "coupon_value": "0.00",
      "pre_paid": true,
      "service_fee": {
        "store": 0,
        "aiq": 0,
        "total": 0
      },
      "total_cancelled_replaced": 10,
      "original_subtotal": 20,
      "total": 10,
      "taxable_total": 10
    },
    "store": {
      "id": 96216,
      "name": "qa-luiz-loja-vip-markup",
      "phones": "(12) 3-2323-1232",
      "preparation_time": 30
    },
    "timeline": {
      "created_at": "2026-01-05 10:58:42",
      "read_at": "2026-01-05 10:58:51",
      "cancelled_at": null,
      "ready_at": "2026-01-05 10:59:03",
      "timezone": "America/Fortaleza"
    },
    "aiqentrega": {
      "ride_id": null,
      "call_at": null,
      "current_status": null,
      "delivered_at": null,
      "last_status": null,
      "last_status_at": null,
      "driver_name": null,
      "driver_phone": null
    }
  }
}

Payload Detalhes Completos do Pedido de Catálogo com item substituído

{
  "data": {
    "id": 68657965,
    "delivery_time": "15 - 30",
    "created_at": "2025-07-25 15:48:15",
    "is_ready": true,
    "is_read": true,
    "is_cancelled": false,
    "is_in_separation": true,
    "is_delivered": false,
    "order_observations": "8316",
    "is_aiqentrega_delivery": true,
    "is_pickup": false,
    "pickup_at": null,
    "coupon_hash": null,
    "user_rating_value": null,
    "is_scheduled": false,
    "scheduled_dates": null,
    "items": [
      {
        "id": "8d82e047-9778-3d9a-859f-d6f8cbccea76",
        "order_item_id": 118055120,
        "name": "item01",
        "replacement_type": 2,
        "status": 1,
        "sku": "item01",
        "category_name": "balas, pirulitos e chicletes",
        "size": "Unidade",
        "unit_value": 10,
        "promotional_value": null,
        "quantity": 1,
        "discount_tax": null,
        "description": "item01",
        "observations": "",
        "unit_packing_fee": "0.00",
        "order_mandatory_items": [],
        "order_additional_items": [],
        "order_item_subitems": []
      },
      {
        "id": "0f338969-6818-3f25-831b-f629a04d2251",
        "order_item_id": 118055121,
        "name": "item02",
        "replacement_type": 2,
        "status": 1,
        "sku": "item02",
        "category_name": "balas, pirulitos e chicletes",
        "size": "Unidade",
        "unit_value": 10,
        "promotional_value": null,
        "quantity": 1,
        "discount_tax": null,
        "description": "item02",
        "observations": "",
        "unit_packing_fee": "0.00",
        "order_mandatory_items": [],
        "order_additional_items": [],
        "order_item_subitems": []
      },
      {
        "id": "19640014-2f49-3a62-854a-a8e47b5f26f9",
        "order_item_id": 118055122,
        "name": "item03",
        "replacement_type": 2,
        "status": 1,
        "sku": "item03",
        "category_name": "balas, pirulitos e chicletes",
        "size": "Unidade",
        "unit_value": 10,
        "promotional_value": null,
        "quantity": 1,
        "discount_tax": null,
        "description": "item03",
        "observations": "",
        "unit_packing_fee": "0.00",
        "order_mandatory_items": [],
        "order_additional_items": [],
        "order_item_subitems": []
      },
      {
        "id": "0de4dddf-bf4c-395b-b762-ca5ab529d045",
        "order_item_id": 118055124,
        "name": "item06",
        "replacement_type": 2,
        "status": 1,
        "sku": "item06",
        "category_name": "balas, pirulitos e chicletes",
        "size": "Unidade",
        "unit_value": 10,
        "promotional_value": 10,
        "quantity": 1,
        "discount_tax": null,
        "description": "item06",
        "observations": "",
        "unit_packing_fee": "0.00",
        "order_mandatory_items": [],
        "order_additional_items": [],
        "order_item_subitems": []
      }
    ],
    "cancelled_items": [],
    "replaced_items": [
      {
        "original": {
          "id": 118055123,
          "name": "item04",
          "size": "Unidade",
          "category": "balas, pirulitos e chicletes",
          "amount": 1,
          "unit_value": 10,
          "total_value": 10,
          "status": 2
        },
        "new": {
          "id": 118055124,
          "name": "item06",
          "size": "Unidade",
          "category": "balas, pirulitos e chicletes",
          "amount": 1,
          "unit_value": 10,
          "total_value": 10,
          "status": 1
        },
        "reason": "problemas com a qualidade do produto"
      }
    ],
    "shipment_status": {
      "latest": null,
      "logs": []
    },
    "user": {
      "uuid": "4444444444444444444",
      "name": "luiz",
      "surname": "do aiq",
      "mobile_phone": "(61) 9-9953-7666",
      "phone_number": "(61) 9-9953-7666",
      "email": "luiz.silva@aiqfome.coma",
      "order_count": 26,
      "document_receipt": null,
      "address": {
        "street_name": "Rua Maringá",
        "number": "5555",
        "complement": "sss",
        "reference": "ss",
        "phone": "(34) 2421-23232",
        "mobile_phone": null,
        "neighborhood_name": "Jardim Aclimação",
        "city_name": "Maringá",
        "state_uf": "PR",
        "ibge_code": "4115200",
        "zip_code": "87050-740",
        "latitude": -23.4454996,
        "longitude": -51.9201468
      }
    },
    "payment_method": {
      "id": 0,
      "name": "Pagamento Online",
      "subtotal": "40.00",
      "delivery_tax": "7.00",
      "total_packing_fee": 0,
      "change": 0,
      "coupon_value": "0.00",
      "pre_paid": true,
      "service_fee": {
        "store": 0,
        "aiq": 0,
        "total": 0
      },
      "total_cancelled_replaced": 0,
      "original_subtotal": 40,
      "total": 47,
      "taxable_total": 47
    },
    "store": {
      "id": 96225,
      "name": "loja qa luiz catalogo e aiqentrega teste sync store merchant api",
      "phones": "(99) 9999-9999",
      "preparation_time": 10
    },
    "timeline": {
      "created_at": "2025-07-25 15:48:15",
      "read_at": "2025-07-25 15:49:17",
      "cancelled_at": null,
      "ready_at": "2025-07-25 15:54:14",
      "timezone": "America/Fortaleza"
    },
    "aiqentrega": {
      "ride_id": 2002183,
      "call_at": null,
      "current_status": "finished",
      "delivered_at": "2025-07-25 15:58:57",
      "last_status": "RideStepCompleted/finished",
      "last_status_at": "2025-07-25 15:58:34",
      "driver_name": "Gianluca Bine",
      "driver_phone": "+5542991044320"
    }
  }
}

Payload Detalhes Completos do Pedido com Entrega Logística

{
  "data": {
    "id": 68670787,
    "delivery_time": "60 - 90",
    "created_at": "2026-01-07 17:10:52",
    "is_ready": false,
    "is_read": false,
    "is_cancelled": false,
    "is_in_separation": false,
    "is_delivered": false,
    "order_observations": "Deixe o pedido na portaria.",
    "is_aiqentrega_delivery": false,
    "is_pickup": false,
    "pickup_at": null,
    "coupon_hash": null,
    "user_rating_value": null,
    "is_scheduled": false,
    "scheduled_dates": null,
    "items": [
      {
        "id": "8b1c0df6-a3b7-4272-b880-0590854a42d4",
        "order_item_id": 118070082,
        "name": "guarana",
        "replacement_type": 0,
        "status": 1,
        "sku": "",
        "category_name": "Sem categoria",
        "size": "",
        "unit_value": 5,
        "promotional_value": null,
        "quantity": 5,
        "discount_tax": null,
        "description": "",
        "observations": "Gelado pls!",
        "unit_packing_fee": "0.00",
        "order_mandatory_items": [],
        "order_additional_items": [],
        "order_item_subitems": []
      }
    ],
    "cancelled_items": [],
    "replaced_items": [],
    "shipment_status": {
      "latest": {
        "status": "order_delivered",
        "metadata": [],
        "created_at": "2026-01-07 17:12:26"
      },
      "logs": [
        {
          "status": "pickup_ongoing",
          "metadata": {
            "driver_name": "Nome do Entregador",
            "driver_phone": "1234567890"
          },
          "created_at": "2026-01-07 17:11:47"
        },
        {
          "status": "arrived_at_merchant",
          "metadata": [],
          "created_at": "2026-01-07 17:11:56"
        },
        {
          "status": "delivery_ongoing",
          "metadata": [],
          "created_at": "2026-01-07 17:12:04"
        },
        {
          "status": "arrived_at_customer",
          "metadata": [],
          "created_at": "2026-01-07 17:12:12"
        },
        {
          "status": "order_delivered",
          "metadata": [],
          "created_at": "2026-01-07 17:12:26"
        }
      ]
    },
    "user": {
      "uuid": "613d3a07-a7ee-11ed-9de5-02c11a0dd08c",
      "name": "luiz",
      "surname": "do aiq",
      "mobile_phone": "(61) 9-9953-7682",
      "phone_number": "(61) 9-9953-7682",
      "email": "luiz.silva@aiqfome.com",
      "order_count": 19,
      "document_receipt": null,
      "address": {
        "street_name": "rua do teste hmo",
        "number": "5242-5",
        "complement": "Apto 45",
        "reference": "Próximo ao shopping",
        "phone": null,
        "mobile_phone": null,
        "neighborhood_name": "CENTRO SUL",
        "city_name": "BARRA DE SAO FRANCISCO",
        "state_uf": "MG",
        "ibge_code": null,
        "zip_code": "37417-210",
        "latitude": null,
        "longitude": null
      }
    },
    "payment_method": {
      "id": 0,
      "name": "PIX - Perto de Você",
      "subtotal": "25.00",
      "delivery_tax": "5.00",
      "total_packing_fee": 0,
      "change": 0,
      "coupon_value": "5.00",
      "pre_paid": false,
      "service_fee": {
        "store": 0,
        "aiq": 0,
        "total": 1
      },
      "total_cancelled_replaced": 0,
      "original_subtotal": 25,
      "total": 26,
      "taxable_total": 25
    },
    "store": {
      "id": 96236,
      "name": "qa-luiz-teste-integrador-entregas",
      "phones": "(99) 9999-9999",
      "preparation_time": 10
    },
    "timeline": {
      "created_at": "2026-01-07 17:10:52",
      "read_at": null,
      "cancelled_at": null,
      "ready_at": null,
      "timezone": null
    },
    "aiqentrega": {
      "ride_id": null,
      "call_at": null,
      "current_status": null,
      "delivered_at": null,
      "last_status": null,
      "last_status_at": null,
      "driver_name": null,
      "driver_phone": null
    }
  }
}

Payload Detalhes Completos do Pedido com Aiqentrega

{
  "data": {
    "id": 68661238,
    "delivery_time": "15 - 30",
    "created_at": "2025-09-22 16:34:36",
    "is_ready": true,
    "is_read": false,
    "is_cancelled": false,
    "is_in_separation": false,
    "is_delivered": false,
    "order_observations": "",
    "is_aiqentrega_delivery": true,
    "is_pickup": false,
    "pickup_at": null,
    "coupon_hash": null,
    "user_rating_value": null,
    "is_scheduled": false,
    "scheduled_dates": null,
    "items": [
      {
        "id": "8d82e047-9778-3d9a-859f-d6f8cbccea76",
        "order_item_id": 118058808,
        "name": "esponja multiuso brilhus leve 4 pague 3",
        "replacement_type": 2,
        "status": 1,
        "sku": "item01",
        "category_name": "balas, pirulitos e chicletes",
        "size": "Unidade",
        "unit_value": 10,
        "promotional_value": null,
        "quantity": 1,
        "discount_tax": null,
        "description": "esponja multiuso brilhus leve 4 pague 3",
        "observations": "",
        "unit_packing_fee": "0.00",
        "order_mandatory_items": [],
        "order_additional_items": [],
        "order_item_subitems": []
      }
    ],
    "cancelled_items": [],
    "replaced_items": [],
    "shipment_status": {
      "latest": null,
      "logs": []
    },
    "user": {
      "uuid": "4444444444444444444",
      "name": "luiz",
      "surname": "do aiq",
      "mobile_phone": "(61) 9-9953-7666",
      "phone_number": "(61) 9-9953-7666",
      "email": "luiz.silva@aiqfome.coma",
      "order_count": 26,
      "document_receipt": null,
      "address": {
        "street_name": "Rua Maringá",
        "number": "5555",
        "complement": "sss",
        "reference": "ss",
        "phone": "(34) 2421-23232",
        "mobile_phone": null,
        "neighborhood_name": "Jardim Aclimação",
        "city_name": "Maringá",
        "state_uf": "PR",
        "ibge_code": "4115200",
        "zip_code": "87050-740",
        "latitude": -23.4454996,
        "longitude": -51.9201468
      }
    },
    "payment_method": {
      "id": 186,
      "name": "Visa Débito",
      "subtotal": "10.00",
      "delivery_tax": "7.00",
      "total_packing_fee": 0,
      "change": 0,
      "coupon_value": "0.00",
      "pre_paid": false,
      "service_fee": {
        "store": 0,
        "aiq": 1,
        "total": 1
      },
      "total_cancelled_replaced": 0,
      "original_subtotal": 10,
      "total": 18,
      "taxable_total": 17
    },
    "store": {
      "id": 96225,
      "name": "loja qa luiz catalogo e aiqentrega teste sync store merchant api",
      "phones": "(99) 9999-9999",
      "preparation_time": 10
    },
    "timeline": {
      "created_at": "2025-09-22 16:34:36",
      "read_at": "2025-11-11 17:54:38",
      "cancelled_at": null,
      "ready_at": "2025-09-22 16:52:19",
      "timezone": "America/Fortaleza"
    },
    "aiqentrega": {
      "ride_id": 2002236,
      "call_at": "2025-09-22 16:50:06",
      "current_status": "delivering",
      "delivered_at": "2025-09-22 16:52:55",
      "last_status": "RideStepCompleted/collected",
      "last_status_at": "2025-09-22 16:51:15",
      "driver_name": "Gianluca Bine",
      "driver_phone": "+5542991044320"
    }
  }
}

Payload Detalhes Completos do Pedido de Cardápio com Múltiplos Sabores

{
  "data": {
    "id": 68672852,
    "delivery_time": "15 - 30",
    "created_at": "2026-01-20 15:23:59",
    "is_ready": false,
    "is_read": false,
    "is_cancelled": false,
    "is_in_separation": false,
    "is_delivered": false,
    "order_observations": "obs do pedido, buzinar 3 vezes ",
    "is_aiqentrega_delivery": false,
    "is_pickup": true,
    "pickup_at": "2026-01-20 15:33:00",
    "coupon_hash": null,
    "user_rating_value": null,
    "is_scheduled": false,
    "scheduled_dates": null,
    "items": [
      {
        "id": null,
        "order_item_id": 118072485,
        "name": "pizza flamengo + pizza frangon + pizza milho com bancon",
        "replacement_type": 0,
        "status": 1,
        "sku": null,
        "category_name": "pizza vário sabores alfredo",
        "size": "grande",
        "unit_value": 10,
        "promotional_value": null,
        "quantity": 1,
        "discount_tax": null,
        "description": "pizza flamengo: pizza flamengo\npizza frangon: pizza frango\npizza milho com bancon: pizza milho com bancon",
        "observations": "obs do item faz a boa",
        "unit_packing_fee": "5.00",
        "order_mandatory_items": [
          {
            "id": 130182959,
            "group": "borda super",
            "name": "borda prato",
            "value": 20,
            "sku": "",
            "quantity": 1
          },
          {
            "id": 130182960,
            "group": "borda super",
            "name": "borda catupiry",
            "value": 30,
            "sku": "",
            "quantity": 1
          },
          {
            "id": 130182961,
            "group": "sachês",
            "name": "Sachê de Ketchup",
            "value": 0,
            "sku": "",
            "quantity": 1
          },
          {
            "id": 130182962,
            "group": "sachês",
            "name": "Sachê de Maionese",
            "value": 0,
            "sku": "",
            "quantity": 1
          },
          {
            "id": 130182963,
            "group": "sachês",
            "name": "Sachê de Mostarda",
            "value": 1.5,
            "sku": "",
            "quantity": 1
          }
        ],
        "order_additional_items": [],
        "order_item_subitems": [
          {
            "id": "4a9263f7-fc83-38a4-95a5-ff70bdabe8a7",
            "name": "pizza flamengo",
            "nome": "pizza flamengo",
            "description": "pizza flamengo",
            "sku": "grande"
          },
          {
            "id": "789b06dc-2dd2-3148-90f2-0df486b287e8",
            "name": "pizza frangon",
            "nome": "pizza frangon",
            "description": "pizza frango",
            "sku": "grande"
          },
          {
            "id": "8cb7aed2-6123-39e9-9d3d-06aa96ad3b46",
            "name": "pizza milho com bancon",
            "nome": "pizza milho com bancon",
            "description": "pizza milho com bancon",
            "sku": "grande"
          }
        ]
      }
    ],
    "cancelled_items": [],
    "replaced_items": [],
    "shipment_status": {
      "latest": null,
      "logs": []
    },
    "user": {
      "uuid": "4444444444444444444",
      "name": "luiz",
      "surname": "do aiq",
      "mobile_phone": "(61) 9-9953-7666",
      "phone_number": "(61) 9-9953-7666",
      "email": "luiz.silva@aiqfome.coma",
      "order_count": 9,
      "document_receipt": null,
      "address": null
    },
    "payment_method": {
      "id": 185,
      "name": "Mastercard Crédito",
      "subtotal": "66.50",
      "delivery_tax": "0.00",
      "total_packing_fee": 5,
      "change": 0,
      "coupon_value": "0.00",
      "pre_paid": false,
      "service_fee": {
        "store": 0,
        "aiq": 0,
        "total": 0
      },
      "total_cancelled_replaced": 0,
      "original_subtotal": 66.5,
      "total": 66.5,
      "taxable_total": 66.5
    },
    "store": {
      "id": 96236,
      "name": "qa-luiz-teste-integrador-entregas",
      "phones": "(99) 9999-9999",
      "preparation_time": 10
    },
    "timeline": {
      "created_at": "2026-01-20 15:23:59",
      "read_at": null,
      "cancelled_at": null,
      "ready_at": null,
      "timezone": "America/Fortaleza"
    },
    "aiqentrega": {
      "ride_id": null,
      "call_at": null,
      "current_status": null,
      "delivered_at": null,
      "last_status": null,
      "last_status_at": null,
      "driver_name": null,
      "driver_phone": null
    }
  }
}

---

Detalhamento dos Campos de Resposta

1. Estrutura Principal (data)

Campo	Descrição
id	ID único do pedido.
delivery_time	Estimativa de tempo de entrega (em minutos, Ex: "20 - 40").
created_at	Data e hora da criação do pedido.
is_ready	Pedido pronto para retirada/entrega (true/false).
is_read	Pedido lido pela loja (true/false).
is_cancelled	Pedido cancelado (true/false).
is_in_separation	Pedido em separação/preparo (true/false).
is_delivered	Pedido entregue (true/false).
order_observations	Observações gerais inseridas pelo cliente no pedido.
is_aiqentrega_delivery	Entrega por logística Aiqfome (true/false).
is_pickup	Pedido para retirada na loja (true/false).
pickup_at	Hora agendada para retirada (se is_pickup for true).
coupon_hash	Código do cupom utilizado, se houver.
user_rating_value	Nota de avaliação do usuário para o pedido.
is_scheduled	Pedido agendado (true/false).
scheduled_dates	Objeto contendo start_date e end_date da janela agendada.
items	Array de itens comprados (ver subestrutura abaixo).
cancelled_items	Array de itens que foram cancelados no pedido.
replaced_items	Array de itens que foram substituídos no pedido.
shipment_status	Objeto de rastreamento logístico.
user	Objeto com informações do cliente.
payment_method	Objeto com detalhes financeiros e de pagamento.
store	Objeto com detalhes da loja.
timeline	Objeto com o histórico de timestamps de status.
aiqentrega	Objeto com detalhes da corrida de entrega (se is_aiqentrega_delivery for true).

2. Subestrutura de Itens (items[])

Campo	Descrição
id	UUID do item do catálogo.
order_item_id	ID do item dentro deste pedido específico.
name	Nome do item.
replacement_type	Tipo de substituição aceito no pedido: 0 - não aceita substituição e nem cancelamento; 1 - não aceita substituição (só cancela); 2 - aceita substituição/cancelamento (valor menor ou igual ao item).
status	Status do item no pedido (1 para ativo e 0 para inativo).
sku	SKU do item, se houver.
category_name	Categoria do item.
size	Unidade aplicada ao item (Ex: "Unidade", "Kg", "g", "P", "G").
unit_value	Valor em R$ correspondente à unidade.
promotional_value	Preço unitário promocional (se aplicado).
quantity	Quantidade pedida do item.
discount_tax	Valor do desconto aplicado ao item.
description	Descrição do item.
observations	Observações específicas do cliente para este item.
unit_packing_fee	Taxa de embalagem unitária.
order_mandatory_items	Array de modificadores obrigatórios (Grupos Mandatórios) selecionados. (Detalhe do Cardápio)
order_additional_items	Array de itens adicionais (opcionais) selecionados. (Detalhe do Cardápio)
order_item_subitems	Array de sub-itens/combos (se aplicável). (Detalhe do Cardápio)

Detalhes de Modificadores Obrigatórios (order_mandatory_items[]) Estes itens representam opções de escolha obrigatória (Grupos Mandatórios), como tipo de borda ou bebida em um combo.

Campo	Descrição
id	ID do item obrigatório.
group	Nome do grupo mandatório ao qual a opção pertence (Ex: "escolha a borda").
name	Nome da opção selecionada (Ex: "Borda de Queijo (+8)").
value	Valor adicional da opção em R$.
sku	SKU do modificador, se houver.
quantity	Quantidade selecionada.

Detalhes de Itens Adicionais (order_additional_items[]) Estes itens representam opções que o cliente pode adicionar ao produto (Opcionais), geralmente com um custo extra.

Campo	Descrição
id	ID do item adicional.
name	Nome da opção (Ex: "Azeitona Extra").
value	Valor adicional da opção em R$.
sku	SKU do modificador, se houver.

Detalhes de Sub-Itens (order_item_subitems[]) Esta estrutura é usada para detalhar as partes de um produto quebrado ou combinado (Ex: sabores individuais de uma pizza meio-a-meio).

Campo	Descrição
id	UUID do sub-item/sabor.
name	Nome do sub-item/sabor (Ex: "pizza vegetariana").
description	Descrição do sub-item/sabor.
sku	SKU do sub-item/sabor, se houver.

3. Subestrutura da Logística de Entrega (shipment_status)

Campo	Descrição
latest	Objeto contendo o status logístico mais recente.
latest.status	Status de entrega da etapa atual (Ex: order_delivered).
latest.metadata	Informações do entregador (driver_name, driver_phone), se disponíveis.
logs	Histórico cronológico de todas as mudanças de status logísticos.

4. Subestrutura de Usuário (user)

Esta seção detalha as informações do cliente que realizou o pedido. Se o pedido for para entrega, ela inclui o sub-objeto address.

Campo	Descrição
uuid	ID único do usuário no sistema Aiqfome.
name	Primeiro nome do cliente.
surname	Sobrenome do cliente.
mobile_phone	Número de telefone móvel do cliente.
phone_number	Número de telefone principal do cliente.
email	E-mail do cliente.
order_count	Número total de pedidos já realizados por este usuário.
document_receipt	CPF ou outro documento fornecido pelo cliente para fins de recibo/nota.
address	Objeto contendo os detalhes do endereço de entrega. null se for pedido de retirada (is_pickup: true).

Detalhes do Endereço (user.address)

Campo	Descrição
street_name	Nome da rua ou avenida.
number	Número do endereço.
complement	Complemento do endereço (Ex: "apto 101").
reference	Ponto de referência.
phone	Telefone fixo associado ao endereço.
mobile_phone	Telefone móvel associado ao endereço.
neighborhood_name	Nome do bairro.
city_name	Nome da cidade.
state_uf	UF (Unidade Federativa) do estado.
ibge_code	Código IBGE da cidade.
zip_code	CEP do endereço.
latitude	Coordenada geográfica de Latitude.
longitude	Coordenada geográfica de Longitude.

5. Subestrutura de Pagamento (payment_method)

Esta seção detalha a forma de pagamento e o resumo financeiro do pedido.

Campo	Descrição
id	ID da forma de pagamento.
name	Nome da forma de pagamento (Ex: "Dinheiro", "Visa Crédito").
subtotal	Soma dos valores dos itens (sem taxa de entrega/embalagem e antes de cancelamentos/substituições).
delivery_tax	Valor da taxa de entrega.
total_packing_fee	Valor total da taxa de embalagem.
change	Valor de troco solicitado pelo cliente (se name for "Dinheiro").
coupon_value	Valor total do cupom de desconto aplicado.
pre_paid	Indica se o pagamento foi feito online (true/false).
service_fee	Objeto detalhando taxas de serviço (loja, Aiqfome, total).
total_cancelled_replaced	Valor total dos itens cancelados ou substituídos.
original_subtotal	Representa o valor total dos itens formalizado no momento da compra. Preserva o montante original, permitindo a comparação com o campo subtotal, que pode refletir o valor final após cancelamentos ou substituições.
total	Valor total final a ser pago pelo cliente (incluindo taxa de entrega/embalagem e descontos). Total = (subtotal + delivery_tax + service_fee - coupon_value)
taxable_total	Valor total tributável.

6. Subestrutura de Dados da Loja (store)

Campo	Descrição
id	ID único da loja vendedora.
name	Nome fantasia da unidade.
phones	Telefones de contato da loja.
preparation_time	Tempo de preparo configurado em minutos.

7. Subestrutura de Linha do Tempo do Pedido (timeline)

Campo	Descrição
created_at	Horário de criação do pedido.
read_at	Horário em que o pedido foi marcado como lido.
ready_at	Horário em que o pedido foi sinalizado como pronto.
cancelled_at	Horário em que ocorreu o cancelamento (se houver).
timezone	Fuso horário referente aos registros de data e hora da timeline.

8. Subestrutura do Aiqentrega (aiqentrega)

Campo	Descrição
ride_id	Identificador numérico único da corrida (entrega) no sistema aiqentrega.
call_at	Data e horário previsto ou realizado para a chamada do entregador.
current_status	Status operacional atual da entrega (Ex: delivering).
delivered_at	Horário exato em que a entrega foi confirmada como concluída.
last_status	Descrição do último estágio logístico processado (Ex: RideStepCompleted/collected).
last_status_at	Data e hora da última atualização de status registrada.
driver_name	Nome completo do entregador alocado para a corrida.
driver_phone	Telefone de contato do entregador (geralmente com máscara ou formato internacional).

Tabela de Status Aiqentrega do campo current_status

Abaixo estão os estados possíveis que o campo current_status pode assumir durante o ciclo de vida da entrega oficial:

Status	Descrição
accepting	O sistema está buscando um entregador disponível para realizar a corrida.
checking	O entregador já está no estabelecimento conferindo os itens do pedido.
collecting	O entregador está realizando a coleta física do pedido na loja.
delivering	O entregador está em deslocamento (rota de entrega) para o endereço do fominha.
returning	O entregador está retornando para a loja.
finished	Ciclo de entrega finalizado com sucesso.
cancelled	A corrida de entrega foi cancelada.