Consulta de pedidos

Listar pedidos

GET

/orders/v1

Antes de confirmar ou cancelar um pedido, é importante acessar os detalhes para que o usuário do seu aplicativo possa verificar se será capaz de entregá-lo. Através do endpoint /orders/v1 você pode obter um resumo das informações de cada pedido recebido como o id pedido, nome da loja, nome do cliente, modalidade e horário de entrega e valor do pedido.

Informações de pedidos

GET

/orders/v1/{order}

Ao consultar o pedido, serão exibidas as demais informações como endereço de entrega, telefone do cliente e outros detalhes.

Descrição dos campos

Campo	Descrição
id	Identificador único do pedido.
status	Situação atual do pedido (normal e cancelled).
delivery_type	Tipo de entrega (ex: normal, agendada).
document_receipt	Documento do recibo da Nota (CPF).
pickup_at	Horário de retirada do pedido.
scheduled_for	Horário agendado para a entrega ou retirada.
is_aiqentrega	Indica se a entrega é pelo aiqentrega.
order_observations	Observação do pedido.
store.id	Identificador da loja.
store.name	Nome da loja.
store.phones	Telefone de contato da loja.
store.avatar	URL da imagem de perfil da loja.
store.business_hours	Horário de funcionamento da loja.
store.preparation_time	Tempo de preparo estimado em minutos.
store.slug	Identificador da loja usado em URLs.
user.id	ID do cliente.
user.name	Primeiro nome do cliente.
user.surname	Sobrenome do cliente.
user.mobile_phone	Telefone celular do cliente.
address.city_name	Nome da cidade.
address.street_name	Nome da rua.
address.number	Número do endereço.
address.complement	Complemento do endereço (ex: "casa").
address.reference	Ponto de referência.
address.zipcode	CEP do endereço.
address.phone	Telefone de contato fixo do fominha, cadastrado junto ao endereço.
address.mobile_phone	Telefone celular de contato do fominha, cadastrado junto ao endereço.
address.neighborhood_name	Nome do bairro.
address.latitude	Latitude do endereço.
address.longitude	Longitude do endereço.
timeline.created_at	Horário da criação do pedido.
timeline.read_at	Horário em que o pedido foi lido.
timeline.in_separation_at	Horário de início da separação do pedido.
timeline.ready_at	Horário em que o pedido ficou pronto para retirada/entrega.
timeline.cancelled_at	Horário em que o pedido foi cancelado.
timeline.delivered_at	Horário em que o pedido foi entregue.
payment_method.name	Método de pagamento (ex: Dinheiro, Mastercard Débito).
payment_method.total	Valor total a ser pago, incluindo taxas.
payment_method.subtotal	Valor total dos itens, sem taxas de entrega.
payment_method.change	Valor de troco para pagamento em dinheiro.
payment_method.delivery_tax	Taxa de entrega.
payment_method.coupon_value	Valor de desconto aplicado por cupom.
payment_method.original_total	Valor total original do pedido.
payment_method.original_subtotal	Subtotal original dos itens.
payment_method.taxable_total	Valor total sujeito a impostos.
payment_method.service_fee.store	Taxa de conveniência da loja.
payment_method.service_fee.aiq	Taxa de conveniência da plataforma.
payment_method.service_fee.total	Valor total da taxa de conveniência.
items.id	ID do item.
items.name	Nome do item.
items.sku	Código de referência (SKU) do produto.
items.category	Categoria do item (ex: Pizzas, Marmitex).
items.size	Tamanho do item (ex: GIGANTE, Pequena).
items.value	Valor unitário do item.
items.quantity	Quantidade do item.
items.discount_tax	Valor do desconto aplicado ao item.
items.description	Descrição do item.
items.observations	Observações adicionais sobre o item.
items.status	Status do item no pedido.
items.reason	Motivo para um status específico, como cancelamento.
items.parent_id	ID do item principal, se este for um adicional.
items.package_value	Valor da embalagem.
items.additional.sku	SKU do item adicional.
items.additional.name	Nome do adicional.
items.additional.value	Valor do adicional.
items.mandatory.sku	SKU da opção obrigatória.
items.mandatory.name	Nome da opção obrigatória.
items.mandatory.group	Grupo ao qual a opção pertence (ex: "Talheres:").
items.mandatory.value	Valor da opção obrigatória.
items.mandatories.name	Nome do grupo de opções.
items.mandatories.description	Descrição do grupo de opções.
items.mandatories.order	Ordem de exibição do grupo.
items.mandatories.minimun_limit	Número mínimo de opções que devem ser selecionadas.
items.mandatories.maximun_limit	Número máximo de opções que podem ser selecionadas.
items.mandatories.items.name	Nome da opção.
items.mandatories.items.description	Descrição da opção.
items.mandatories.items.value	Valor da opção.
items.mandatories.items.id	ID da opção.
items.mandatories.items.status	Status da opção (ex: true para ativa).
items.sub.sku	SKU do sub-item.
items.sub.name	Nome do sub-item.
items.sub.description	Descrição do sub-item.
cancelled_items	Lista de itens cancelados no pedido.
replaced_items	Lista de itens substituídos.
ride	Informações sobre a corrida do entregador.
call.last_status	Último status de uma tentativa de contato.
call.count	Número de tentativas de contato.

Exemplo de pedido de restaurante (MOD1)

{
  "data": {
    "id": 999999999,
    "status": "normal",
    "delivery_type": "normal",
    "document_receipt": "000.000.000-00",
    "pickup_at": null,
    "scheduled_for": null,
    "is_aiqentrega": false,
    "store": [
      {
        "id": 999999,
        "name": "restaurante",
        "phones": "(99) 9999-9999",
        "avatar": "",
        "business_hours": "10:45 - 14:20",
        "preparation_time": 10,
        "slug": "fake-restaurante"
      }
    ],
    "user": {
      "id": 9999999,
      "name": "Name",
      "surname": "Test"
    },
    "address": {
      "city_name": "Florianópolis",
      "street_name": "Rua fake test",
      "number": "99",
      "complement": "Casa",
      "reference": "",
      "zipcode": "88010-905",
      "phone": "99999999999",
      "mobile_phone": null,
      "neighborhood_name": "Centro",
      "lattitude": "-26.3255",
      "longitude": "-81.8359"
    },
    "timeline": {
      "created_at": "2025-06-08T09:00:03+00:00",
      "read_at": "2025-06-08T09:00:35+00:00",
      "in_separation_at": null,
      "ready_at": null,
      "cancelled_at": null,
      "delivered_at": "2025-06-08T12:03:25+00:00"
    },
    "payment_method": {
      "name": "Dinheiro",
      "total": 2699,
      "subtotal": 2200,
      "change": 20000,
      "delivery_tax": 499,
      "coupon_value": 0,
      "original_total": 2699,
      "original_subtotal": 2200,
      "taxable_total": 2699,
      "service_fee": {
        "store": 0,
        "aiq": 0,
        "total": 0
      }
    },
    "items": [
      {
        "id": 999999999,
        "name": "Marmitex Z",
        "sku": "",
        "category": "Marmitex",
        "size": "Pequena",
        "value": 2200,
        "quantity": 1,
        "discount_tax": null,
        "description": "arroz, feijão, farofa, batata frita, churrasco.",
        "observations": "",
        "status": 1,
        "reason": null,
        "parent_id": null,
        "package_value": 0,
        "additional": [
          {
            "sku": "",
            "name": "batata frita extra",
            "value": 300
          },
          {
            "sku": "",
            "name": "dobro de carne",
            "value": 1000
          }
        ],
        "mandatory": [
          {
            "sku": "",
            "name": "Não, valeu!",
            "group": "Talheres:",
            "value": 0
          }
        ],
        "sub": []
      }
    ],
    "cancelled_items": [],
    "replaced_items": [],
    "ride": null,
    "call": {
      "last_status": null,
      "count": 0
    }
  }
}

Exemplo de pedido de pizzaria (MOD2)

{
  "data": {
    "id": 999999999,
    "status": "normal",
    "delivery_type": "normal",
    "document_receipt": "000.000.000-00",
    "pickup_at": null,
    "scheduled_for": null,
    "is_aiqentrega": false,
    "store": [
      {
        "id": 999999,
        "name": "restaurante",
        "phones": "(99) 9999-9999",
        "avatar": "",
        "business_hours": "10:45 - 14:20",
        "preparation_time": 10,
        "slug": "fake-restaurante"
      }
    ],
    "user": {
      "id": 9999999,
      "name": "Name",
      "surname": "Test"
    },
    "address": {
      "city_name": "Florianópolis",
      "street_name": "Rua fake test",
      "number": "99",
      "complement": "Casa",
      "reference": "",
      "zipcode": "88010-905",
      "phone": "99999999999",
      "mobile_phone": null,
      "neighborhood_name": "Centro",
      "lattitude": "-26.3255",
      "longitude": "-81.8359"
    },
    "timeline": {
      "created_at": "2025-06-08T09:00:03+00:00",
      "read_at": "2025-06-08T09:00:35+00:00",
      "in_separation_at": null,
      "ready_at": null,
      "cancelled_at": null,
      "delivered_at": "2025-06-08T12:03:25+00:00"
    },
    "payment_method": {
      "name": "Mastercard Débito",
      "total": 6300,
      "subtotal": 5500,
      "change": 0,
      "delivery_tax": 800,
      "coupon_value": 0,
      "original_total": 550800,
      "original_subtotal": 5500,
      "taxable_total": 6300,
      "service_fee": {
        "store": 0,
        "aiq": 0,
        "total": 0
      }
    },
    "ride": null,
    "items": [
      {
        "id": 84264036,
        "name": "portuguesa + calabresa",
        "sku": "",
        "category": "pizzas",
        "size": "GIGANTE",
        "value": 5500,
        "quantity": 1,
        "discount_tax": 0,
        "description": "",
        "observations": "",
        "status": 1,
        "reason": null,
        "parent_id": null,
        "package_value": 0,
        "additional": [
          {
            "sku": "talheres",
            "name": "",
            "value": 0
          },
          {
            "sku": "",
            "name": "dobro de queijo",
            "value": 1000
          }
        ],
        "mandatories": [
          {
            "name": "Escolha a borda",
            "description": "",
            "order": 1,
            "minimun_limit": 1,
            "maximun_limit": 3,
            "items": [
              {
                "name": "borda 0800",
                "description": "borda tradicioanl",
                "value": 0,
                "id": "#BORDA001",
                "status": true
              },
              {
                "name": "borda queijo",
                "description": "borda queijo",
                "value": 10,
                "id": "#BORDA002",
                "status": true
              }
            ]
          }
        ],
        "sub": [
          {
            "sku": "",
            "name": "portuguesa",
            "description": "molho de tomate, mussarela, presunto, ovos e cebola. "
          },
          {
            "sku": "",
            "name": "calabresa",
            "description": "molho de tomate, mussarela, calabresa. "
          }
        ]
      }
    ],
    "cancelled_items": [],
    "replaced_items": [],
    "call": {
      "last_status": null,
      "count": 0
    }
  }
}