Skip to main content
GET /v1/orders/{orderId} devolve o pedido como ele está agora. A lista completa, com os campos fixos para ignorar, está em Consultar pedido.

Identificadores

  • id. Identificador único. Guarde: é ele que entra em GET /v1/orders/{orderId}.
  • displayId. Código que a loja vê no painel e na impressão. Mostre para a loja conferir. O número curto do painel (“Pedido 300”) não vem na API e reinicia todo mês.
  • merchant.id. Código da loja no PDV que sincroniza o catálogo dela. Sem sincronização, vem o UUID da loja na Onbeef. Se não é você quem envia o catálogo, roteie pela chave que fez a consulta.

Itens

  • id é o Código de integração com PDV do produto, o mesmo id que você envia no catálogo, sem prefixo.
  • id em formato UUID é produto sem vínculo. O valor muda a cada pedido: não cadastre como código de produto. Peça à loja para preencher o código e consulte de novo, mesmo se você não envia catálogo. Em kit, confira cada produto. Veja Vincule produtos que já existem.
  • externalCode é o código de balança. Não é o código do PDV.
  • unit: "KG". quantity vem em quilos (1.32 = 1,320 kg) e unitPrice é o preço por quilo. Com "UN", unidades e preço de cada uma.
  • Corte. Vem em options[] com unit: "KG", peso e observação, sempre com preço zero. O id é o de cuts[].id em GET /v1/merchant.
  • Adicional. Vem em options[] sem unit, com preço. O id é sempre um UUID.
  • Observação. A do item vem em specialInstructions. A do pedido, em extraInfo.

Valor da linha

Na Picanha: 94,90 x 1,32 = 125,27, mais 3,00 do adicional, dá 128,27. Se o documento fiscal exige unitPrice x quantity = totalPrice, lance o adicional como linha à parte.

Kit

O kit vem como uma linha, com kit_id: null. Cada produto escolhido vem em outra, com kit_id igual ao id da linha do kit.
  • Kit com preço próprio, como o de Preço Fechado. A linha do kit traz o preço. As dos produtos vêm com valor zero, ou só com o acréscimo da escolha.
  • Kit de Preço Aberto. A linha do kit vem com valor zero. Cada produto traz o próprio preço.
O exemplo é um kit de Preço Fechado. Cada real aparece em uma linha só: some o totalPrice de todas as linhas, como a API faz em total.itemsPrice. O id do kit é o código do PDV, se a loja preencheu, ou um UUID.

Totais

itemsPrice soma o totalPrice dos itens. otherFees soma o frete (DELIVERY_FEE) e a taxa de serviço (SERVICE_FEE). Os valores vêm em reais, com duas casas, arredondados: 1,320 kg a R$ 94,90 dá 125,268 e sai 125.27. Frete grátis da fidelidade vem como frete mais um desconto do mesmo valor. Se a loja não cobra frete, otherFees vem sem DELIVERY_FEE.
Aqui, 148,27 + 8,00 - 8,00 = 148,27.
  • Um item de discounts[] por desconto. Cupom, clube, fidelidade, cashback, agendamento e desconto da loja, sem campo com o tipo. O cupom traz o código em sponsorshipValues[].discountCode. O target é CART (itens) ou DELIVERY_FEE (frete).
  • Desconto da loja. O de Desconto personalizado vem em discounts[]. O de Ajustar valor não vem: o pedido sai com a soma dos itens. Veja Desconto dado pela loja.

Pagamento

  • type: "PREPAID". Já está pago. Não cobre.
  • type: "PENDING". Não está pago. Cobre na entrega só se method for dinheiro, PIX, cartão ou vale e a loja confirmar que o pedido é para pagar na entrega.
method: PIX, CREDIT (inclusive Apple Pay), DEBIT, CASH, FOOD_VOUCHER (vale alimentação), MEAL_VOUCHER (vale refeição) ou OTHER.
  • Online ou na entrega. A API não tem campo que separe pagamento na entrega de pagamento online em andamento: cartão online ainda não capturado também sai CREDIT com PENDING.
  • OTHER nunca se cobra na porta. O nome vem em methodInfo, texto livre: “Pagamento a prazo (Nota/Fiado)”, “Link de pagamento”, “Link via Whatsapp” ou a forma criada pela loja, como boleto.
  • Troco. Em CASH, changeFor traz o valor que o cliente vai entregar.
  • Pago na entrega continua PENDING depois do DELIVERED: a API não registra o recebimento na porta.
  • O valor vem do total. value, prepaid e pending repetem o total.orderAmount, recalculado a cada consulta. Se falta pagar uma diferença depois do ajuste, o pedido sai PENDING com o total inteiro.
  • O que não vem. Valor cobrado no cartão ou no PIX, estorno, data do pagamento e currency nos números de payments.

Cliente

documentNumber traz o CPF ou CNPJ informado no pedido ou, na falta dele, o do cadastro do cliente na loja. A API não diz se o cliente pediu o documento na nota.

Entrega, retirada e datas

Em type: "DELIVERY" vem o bloco delivery, com o endereço em deliveryAddress e a hora da entrega em deliveryDateTime. Em "TAKEOUT" vem o bloco takeout: a hora em que o cliente retirou não vem na API. Pedido para agora vem com orderTiming: "INSTANT" e schedule: null. O agendado vem assim:
createdAt é o dia em que o cliente fez o pedido. O dia da entrega está em schedule. O start_at do polling olha o createdAt: veja Pedido agendado na virada. Toda data vem em UTC, em ISO 8601. Converta para o horário da loja: 17:30 UTC é 14:30 em Brasília.

Quando importar o pedido

Quando peso e total não mudam mais.

Consultar pedido

Todos os campos.