Consulte um pedido

curl --request GET \
  --url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId} \
  --header 'Authorization: Bearer <token>'

{
  "id": {},
  "type": "<string>",
  "sourceAppId": {},
  "virtualBrand": "<string>",
  "displayId": "<string>",
  "salesChannel": "<string>",
  "createdAt": {},
  "lastEvent": "<string>",
  "merchant": {
    "merchant.id": "<string>",
    "merchant.name": "<string>"
  },
  "items": {
    "items[].id": "<string>",
    "items[].name": "<string>",
    "items[].externalCode": "<string>",
    "items[].unit": "<string>",
    "items[].quantity": 123,
    "items[].specialInstructions": "<string>",
    "items[].unitPrice": {},
    "items[].originalPrice": {},
    "items[].totalPrice": {},
    "items[].options": {}
  },
  "total": {
    "total.itemsPrice": {},
    "total.otherFees": {},
    "total.discount": {},
    "total.orderAmount": {}
  },
  "customer": {
    "customer.id": {},
    "customer.name": "<string>",
    "customer.phone": {},
    "customer.email": "<string>",
    "customer.documentNumber": "<string>",
    "customer.ordersCountOnMerchant": 123
  },
  "payments": {
    "payments.prepaid": 123,
    "payments.pending": 123,
    "payments.methods": {}
  },
  "delivery": {
    "delivery.deliveredBy": "<string>",
    "delivery.deliveryAddress": {},
    "delivery.estimatedDeliveryDateTime": {},
    "delivery.deliveryDateTime": {}
  },
  "orderTiming": "<string>",
  "schedule": {},
  "takeout": {},
  "otherFees": {},
  "discounts": {},
  "extraInfo": "<string>",
  "preparationStartDateTime": {},
  "sendTracking": true,
  "sendDelivered": true
}

GET

orders

{orderId}

Consulte um pedido

curl --request GET \
  --url https://api.dev.connect.onbeefapp.com.br/v1/orders/{orderId} \
  --header 'Authorization: Bearer <token>'

{
  "id": {},
  "type": "<string>",
  "sourceAppId": {},
  "virtualBrand": "<string>",
  "displayId": "<string>",
  "salesChannel": "<string>",
  "createdAt": {},
  "lastEvent": "<string>",
  "merchant": {
    "merchant.id": "<string>",
    "merchant.name": "<string>"
  },
  "items": {
    "items[].id": "<string>",
    "items[].name": "<string>",
    "items[].externalCode": "<string>",
    "items[].unit": "<string>",
    "items[].quantity": 123,
    "items[].specialInstructions": "<string>",
    "items[].unitPrice": {},
    "items[].originalPrice": {},
    "items[].totalPrice": {},
    "items[].options": {}
  },
  "total": {
    "total.itemsPrice": {},
    "total.otherFees": {},
    "total.discount": {},
    "total.orderAmount": {}
  },
  "customer": {
    "customer.id": {},
    "customer.name": "<string>",
    "customer.phone": {},
    "customer.email": "<string>",
    "customer.documentNumber": "<string>",
    "customer.ordersCountOnMerchant": 123
  },
  "payments": {
    "payments.prepaid": 123,
    "payments.pending": 123,
    "payments.methods": {}
  },
  "delivery": {
    "delivery.deliveredBy": "<string>",
    "delivery.deliveryAddress": {},
    "delivery.estimatedDeliveryDateTime": {},
    "delivery.deliveryDateTime": {}
  },
  "orderTiming": "<string>",
  "schedule": {},
  "takeout": {},
  "otherFees": {},
  "discounts": {},
  "extraInfo": "<string>",
  "preparationStartDateTime": {},
  "sendTracking": true,
  "sendDelivered": true
}

Use o orderId recebido em um evento. A resposta contém itens, cliente, pagamento, entrega, valores e estado atual.

Parâmetros de rota

string (uuid)

required

Identificador único do pedido, gerado pela Onbeef. Você recebe este valor no campo orderId de qualquer evento de pedido retornado pelo endpoint de polling.

Resposta

200: Sucesso

Retorna o objeto completo do pedido.

string (uuid)

Identificador único do pedido.

string

Tipo do pedido, por exemplo DELIVERY ou TAKEOUT.

string (uuid)

Identificador da aplicação que originou o pedido.

string

Marca virtual associada ao pedido, se aplicável.

string

Identificador legível do pedido exibido aos clientes.

string

Canal pelo qual o pedido foi realizado.

string (date-time)

Timestamp ISO 8601 de quando o pedido foi criado.

string

Evento mais recente no ciclo de vida do pedido (por exemplo, CREATED, CONFIRMED, DELIVERED).

object

Informações sobre o merchant que atende o pedido.

Show Campos de merchant

string

Identificador do merchant. Quando a loja está vinculada ao PDV, é o pdv_external_id enviado no merchantUpdate; caso contrário, é o UUID interno da Onbeef.

string

Nome de exibição do merchant.

array of objects

Lista de itens incluídos no pedido.

Show Campos de item

string

Identificador do item. Quando o produto está vinculado ao PDV, é o pdv_external_id; caso contrário, é o UUID interno da Onbeef.

string

Nome de exibição do item.

string

Código de balança do produto, usado pelos recursos de balança do painel.

string

Unidade de medida, por exemplo UN.

number

Quantidade pedida. É um inteiro para itens vendidos por unidade (unit: "UN") e um número fracionário para itens vendidos por peso (unit: "KG", por exemplo 1.5 para 1,5 kg).

string

Instruções especiais do cliente para este item.

object

Preço unitário com value (número em reais, BRL) e currency (por exemplo, "BRL").

object

Preço unitário original (antes de descontos aplicados no item), com value e currency.

object

Preço total da linha com value (em reais, BRL) e currency.

array of objects

Opções de customização selecionadas (adicionais, variantes), cada uma com id, name, quantity, unitPrice e totalPrice.

object

Detalhamento de totais do pedido.

Show Campos de total

object

Preço total de todos os itens (value + currency).

object

Taxas adicionais, como taxa de entrega (value + currency).

object

Total de desconto aplicado (value + currency).

object

Total cobrado do cliente (value + currency).

object

Informações do cliente.

Show Campos de customer

string (uuid)

Identificador único do cliente.

string

Nome completo do cliente.

object

Telefone do cliente com number e extension opcional.

string

E-mail do cliente.

string

Número do documento fiscal do cliente (CPF/CNPJ).

integer

Quantidade de pedidos anteriores que este cliente fez na sua loja.

object

Detalhes de pagamento do pedido.

Show Campos de payments

number

Valor já pago pelo cliente (por exemplo, no app).

number

Valor a ser cobrado na entrega.

array of objects

Lista de meios de pagamento utilizados, cada um com value, currency, type (PREPAID/PENDING), method (por exemplo, CREDIT, CASH), brand e changeFor opcional.

object

Informações da entrega (presente quando type é DELIVERY).

Show Campos de delivery

string

Quem é responsável pela entrega. Atualmente a API sempre retorna MERCHANT (a entrega é conduzida pela integração do merchant).

object

Endereço completo de entrega incluindo street, number, complement, district, city, state, postalCode, country, formattedAddress, reference e coordinates (latitude, longitude).

string (date-time)

Tempo estimado de entrega.

string (date-time)

Data/hora real de entrega, uma vez entregue.

string

Indica se o pedido é INSTANT (entregar o mais rápido possível) ou SCHEDULED.

object

Janela de entrega agendada, presente quando orderTiming é SCHEDULED, com scheduledDateTimeStart e scheduledDateTimeEnd. null para pedidos INSTANT.

object

Informações de retirada (presente quando type é TAKEOUT), com mode e takeoutDateTime.

array of objects

Taxas adicionais do pedido (por exemplo, frete e taxa de serviço). Cada objeto tem name, type (por exemplo, DELIVERY_FEE, SERVICE_FEE) e price (value + currency).

array of objects

Descontos aplicados ao pedido, cada um com amount (value + currency), target e sponsorshipValues.

string

Observações do pedido (comentários do cliente).

string (date-time) | null

Momento em que o preparo começou, quando disponível.

boolean

Indica se sua integração deve enviar atualizações de rastreamento via POST /v1/orders/{orderId}/tracking. Atualmente a API sempre retorna true.

boolean

Indica se o pedido espera confirmação de entrega. Atualmente a API sempre retorna true.

401: Não autorizado

Retornado quando a requisição não inclui credenciais de autenticação válidas.

404: Não encontrado

Nenhum pedido foi encontrado com o orderId informado.

429: Limite de requisições

A rota aceita até 200 requisições por minuto, num limite compartilhado com as outras rotas de leitura. Acima disso, a API responde { "title": "Too Many Requests", "status": 429 }. Veja Limite de requisições.

Exemplo de requisição

curl --request GET \
  --url "https://api.dev.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  --header "Authorization: Bearer <token>"

curl --request GET \
  --url "https://api.connect.onbeefapp.com.br/v1/orders/f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  --header "Authorization: Bearer <token>"

Exemplo de resposta

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "DELIVERY",
  "displayId": "ABC-123",
  "salesChannel": "ONBEEF",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastEvent": "CREATED",
  "merchant": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "Meu Açougue"
  },
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "Picanha",
      "externalCode": "MEAT-001",
      "unit": "KG",
      "quantity": 1.5,
      "specialInstructions": "Corte em bifes",
      "unitPrice": { "value": 89.90, "currency": "BRL" },
      "originalPrice": { "value": 89.90, "currency": "BRL" },
      "totalPrice": { "value": 134.85, "currency": "BRL" },
      "options": []
    }
  ],
  "otherFees": [
    { "name": "Frete", "type": "DELIVERY_FEE", "price": { "value": 5.00, "currency": "BRL" } }
  ],
  "discounts": [],
  "total": {
    "itemsPrice": { "value": 134.85, "currency": "BRL" },
    "otherFees": { "value": 5.00, "currency": "BRL" },
    "discount": { "value": 0, "currency": "BRL" },
    "orderAmount": { "value": 139.85, "currency": "BRL" }
  },
  "customer": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "João da Silva",
    "phone": { "number": "+5511999999999", "extension": null },
    "email": "joao@example.com",
    "documentNumber": null,
    "ordersCountOnMerchant": 3
  },
  "payments": {
    "prepaid": 139.85,
    "pending": 0,
    "methods": [
      {
        "value": 139.85,
        "currency": "BRL",
        "type": "PREPAID",
        "method": "CREDIT",
        "brand": null,
        "methodInfo": null
      }
    ]
  },
  "delivery": {
    "deliveredBy": "MERCHANT",
    "deliveryAddress": {
      "street": "Rua das Flores",
      "number": "100",
      "district": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "postalCode": "01310-100",
      "country": "BR",
      "formattedAddress": "Rua das Flores, 100 - Centro, São Paulo - SP",
      "coordinates": { "latitude": -23.5505, "longitude": -46.6333 }
    }
  },
  "orderTiming": "INSTANT",
  "sendTracking": true,
  "sendDelivered": true
}

Os valores monetários na resposta (por exemplo, unitPrice.value) são expressos em reais (BRL) como número decimal, por exemplo 89.90 para R$ 89,90. Não divida por 100.

Visão geral

Autenticação

Merchant

Pedidos

Logística

Consulte um pedido

Parâmetros de rota

Resposta

200: Sucesso

401: Não autorizado

404: Não encontrado

429: Limite de requisições

Exemplo de requisição

Exemplo de resposta

​Parâmetros de rota

​Resposta

​200: Sucesso

​401: Não autorizado

​404: Não encontrado

​429: Limite de requisições

​Exemplo de requisição

​Exemplo de resposta

Parâmetros de rota

Resposta

200: Sucesso

401: Não autorizado

404: Não encontrado

429: Limite de requisições

Exemplo de requisição

Exemplo de resposta