OrderSummary
- additionalType: stringrequired
Acréscimo pontual, em BRL.
- deliveryType: string
_fee requiredTaxa de entrega cobrada, em BRL.
- discountType: stringrequired
Desconto aplicado, em BRL.
- idType: integerrequired
Id do pedido. Passe-o para
/api/order/details/. - invoiceType: boolean
_generated requiredtruequando uma nota fiscal foi emitida. - isType: boolean
_recent _customer requiredtruequando o cliente já havia pedido recentemente antes deste pedido. - isType: boolean
_scheduled requiredtruequando o pedido foi agendado com antecedência. - paidType: booleanrequired
truequando o pedido está totalmente liquidado. - productsType: string
_total requiredSoma das linhas de produto incluindo a taxa de entrega, em BRL.
- serviceType: string
_fee requiredTaxa de serviço cobrada, em BRL.
- statusType: stringrequired
Status do pedido:
pending,pending_payment,accepted,preparing,finishing,ready,dispatched,delivered,cancelled,abandoned,changed,exchanged,transferred,scheduled. - totalType: stringrequired
products_total - discount + additional, em BRL. - cancellationType: stringnullable
_reason Motivo do cancelamento do pedido.
- commentsType: stringnullable
Observação deixada pelo cliente.
- createdType: stringFormat: date-timenullable
_at Horário local sem fuso (naive) no fuso horário da loja (veja
timezone_offsetem/api/store/info/). - customerType: nullableProperties: 3
Cliente ao qual o pedido pertence, quando não é anônimo.
- deliveredType: stringFormat: date-timenullable
_at Horário local sem fuso (naive) no fuso horário da loja (veja
timezone_offsetem/api/store/info/). - deliveryType: nullable
_address Properties: 11Endereço para o qual o pedido é entregue, conforme capturado no momento do pedido.
- deliveryType: stringnullable
_time Horário de entrega prometido como
HH:MM, local à loja. - discountType: stringnullable
_reason Motivo do desconto.
- displayType: stringnullable
_number Número do balcão ou nome chamado exibido ao cliente.
- finishedType: stringFormat: date-timenullable
_at Horário local sem fuso (naive) no fuso horário da loja (veja
timezone_offsetem/api/store/info/). - integrationType: stringnullable
_code Id do pedido na plataforma parceira, para pedidos integrados.
- integrationType: stringnullable
_display _id Código curto do pedido exibido pela plataforma parceira.
- orderType: stringnullable
_type delivery(Delivery),takeout(Retirada),dine_in(Vem comer),salon(Salão) ounumber(Senha). - scheduledType: stringFormat: date-timenullable
_for Quando o cliente solicitou o pedido. Horário local sem fuso (naive) no fuso horário da loja (veja
timezone_offsetem/api/store/info/). - sequenceType: integernullable
Número de sequência diário usado pela loja.
- sourceType: stringnullable
Canal pelo qual o pedido chegou, ex.:
terminal,app,ifood.