Consulta de pedidos
Listar pedidos
GET
/orders/v1Antes 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.
As informações completas do pedido só serão exibidos após a marcação como pedido lido.
Informações de pedidos
GET
/orders/v1/{order}Após o pedido lido, serão exibidas as demais informações como endereço de entrega, telefone do cliente e outros detalhes do pedido.
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
}
}
}