1. Orders
Alfalabs API v2
  • Raiz
    • Orders
      • GET /orders
        GET
      • POST /orders
        POST
      • PUT /orders/status
        PUT
    • Users
      • GET /users
    • Delivery
      • GET /deliveryAreas
    • Nfc
      • GET /nfc
      • POST /nfc
    • Ratings
      • GET /ratings
    • Accounts
      • GET /accounts
    • Discount Coupons
      • GET /discountCoupons
      • GET /discountCoupons/id
      • POST /discountCoupons
      • PUT /discountCoupons
      • DELETE /discountCoupons
    • Webhook
  1. Orders

GET /orders

GET
/v2/orders
Busca pedidos com filtros opcionais.

Parâmetros de Query#

CampoTipoObrigatórioDescrição
idintegeropcionalID do pedido
externalCodestringopcionalCódigo externo do pedido
statusintegeropcionalStatus do pedido (1–6)
datestringopcionalData no formato YYYY-MM-DD
pageintegeropcionalPágina (padrão: 1)

Exemplo de Resposta (200)#

{
	"success": true,
	"totalPags": null,
	"data": [
		{
			"id": "3218614",
			"created_at": "2025-11-25 15:03:13",
			"status": "Finalizado",
			"number": 3967,
			"origin": "Telefone",
			"deliveryType": "Delivery",
			"documentReceipt": null,
			"observations": "pedido de teste",
			"merchant": {
				"id": 1,
				"name": "A"
			},
			"rating": {
				"value": null,
				"description": null
			},
			"customer": {
				"id": 721566,
				"name": "felipe",
				"email": "",
				"phone": "(47) 99987-0488",
				"document": "00.000.000/0000-00"
			},
			"address": {
				"id": 737653,
				"pickupCode": null,
				"streetName": "Rua Leão Marinho",
				"streetNumber": "123",
				"postalCode": "88215000",
				"city": "São Paulo",
				"neighborhood": "Vila Marieta",
				"state": null,
				"country": "Brasil",
				"reference": "lado",
				"complement": "casa",
				"coordinates": {
					"latitude": null,
					"longitude": null
				}
			},
			"payments": [
				{
					"method": "Cartão de Débito",
					"value": 50,
					"pending": false,
					"card": {
						"brand": "Maestro"
					}
				},
				{
					"method": "Dinheiro",
					"value": 53,
					"pending": false,
					"cash": {
						"changeFor": 100
					}
				}
			],
			"items": [
				{
					"id": "6045565",
					"name": "X-Tudo",
					"externalCode": null,
					"quantity": 2,
					"unitPrice": 50,
					"price": 100,
					"observations": null,
					"category": "Sobremesa",
					"flavors": [],
					"additions": [],
					"complements": [
						{
							"title": "Ponto da carne",
							"chargeHigherPrice": false,
							"chargeMediumPrice": false,
							"options": [
								{
									"name": "Mal passado",
									"externalCode": "mp",
									"quantity": 1,
									"unitPrice": 0,
									"price": 0
								}
							]
						}
					]
				}
			],
			"timeline": [
				{
					"status": "Realizado",
					"date": "2025-11-25 15:03:13"
				},
				{
					"status": "Finalizado",
					"date": "2025-11-25 15:03:20"
				}
			],
			"discountDetails": {
				"code": null,
				"discount": 0,
				"marketplace": 0,
				"fixe": 0,
				"cashback": 0,
				"total": 0
			},
			"total": {
				"subTotal": 100,
				"deliveryFee": 3,
				"discount": 0,
				"addition": 0,
				"orderAmount": 103
			}
		}
	]
}

Códigos de Resposta#

CódigoDescrição
200Sucesso
400Parâmetros inválidos
401Token ausente ou inválido
500Erro interno

Requisição

Parâmetros Header

Respostas

🟢200
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.alfalabs.com.br/v2/v2/orders' \
--header 'Authorization: Bearer {{token}}'
Response Response Example
{}
Modificado em 2026-04-27 19:39:30
Página anterior
Orders
Próxima página
POST /orders
Built with