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 emGET /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 mesmoidque você envia no catálogo, sem prefixo.idem 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".quantityvem em quilos (1.32 = 1,320 kg) eunitPriceé o preço por quilo. Com"UN", unidades e preço de cada uma.- Corte. Vem em
options[]comunit: "KG", peso e observação, sempre com preço zero. Oidé o decuts[].idemGET /v1/merchant. - Adicional. Vem em
options[]semunit, com preço. Oidé sempre um UUID. - Observação. A do item vem em
specialInstructions. A do pedido, emextraInfo.
Valor da linha
unitPrice x quantity = totalPrice, lance o adicional como linha à parte.
Kit
O kit vem como uma linha, comkit_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.
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.
- 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 emsponsorshipValues[].discountCode. OtargetéCART(itens) ouDELIVERY_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ó semethodfor 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
CREDITcomPENDING. OTHERnunca se cobra na porta. O nome vem emmethodInfo, texto livre: “Pagamento a prazo (Nota/Fiado)”, “Link de pagamento”, “Link via Whatsapp” ou a forma criada pela loja, como boleto.- Troco. Em
CASH,changeFortraz o valor que o cliente vai entregar. - Pago na entrega continua
PENDINGdepois doDELIVERED: a API não registra o recebimento na porta. - O valor vem do total.
value,prepaidependingrepetem ototal.orderAmount, recalculado a cada consulta. Se falta pagar uma diferença depois do ajuste, o pedido saiPENDINGcom o total inteiro. - O que não vem. Valor cobrado no cartão ou no PIX, estorno, data do pagamento e
currencynos números depayments.
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
Emtype: "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.
