get https://{environment}.app/orders
Use esta api para buscar pedidos
Descrição dos filtros de busca
Status | Descrição |
---|---|
WaitingWaveCreation | Aguardando geração de onda |
WaitingConfirmation | Aguardando confirmação |
WaveAvailable | Onda disponível |
WaveInProgress | Processo de separação iniciado |
WaveCompleted | Processo de separação concluído |
WaveCompletedWithErrorsjnn | Processo de separação concluído com ocorrências |
CheckoutInProgress | Processo de conferência iniciado |
CheckoutCompleted | Processo de conferência concluído |
InvoicePending | Faturamento pendente |
InvoicingInProgress | Faturamento solicitado, aguardando liberação |
Invoiced | Faturado |
ShipmentInProgress | Processo de expedição em andamento |
ShipmentCompleted | Processo de expedição concluído |
Cancelled | Cancelado |
ShippingStarted | Enviado para transportadora |
ShippingRejected | Rejeitado pelo cliente ou pela transportadora |
ShippingCancelled | Solicitação de entrega cancelada |
ShippingReturned | Não entregue para o destinatário (retornado) |
ShippingStrayed | Não entregue para o destinatário (extraviado) |
ShippingDelivered | Entregue pela transportadora |
Resposta
Campo | Tipo | Descrição |
---|---|---|
- items | array | Lista de pedidos |
id* | number | Identificador único do pedido |
orderNumber* | string | Identificador único do pedido no sistema externo |
creationDate* | datetime | Data em que o pedido foi criado em nossa plataforma (Fuso horário UTC) |
single* | boolean | Flag que indica se o pedido tem apenas um item |
multipleStores* | boolean | Flag que indica se o pedido foi dividido para mais de uma loja |
express* | boolean | Flag que indica se o pedido é expresso |
storeId* | number | Identificador da loja responsável pelo pedido |
storeName* | string | Nome da loja responsável pelo pedido |
status* | string | Status do pedido (Active ou Cancelled) |
progress* | string | Progresso do pedido (conforme descrito na tabela) |
total* | number | Quantidade de itens do pedido |
promiseDate* | datetime | Previsão de entrega do pedido (Fuso horário UTC) |
deliveryDate | datetime | Data em que o pedido foi entregue (Fuso horário UTC) |
deliveryType* | string | Tipo de entrega do pedido |
deliveryModeName* | string | Modalidade de entrega do pedido |
deliveryChannel* | string | Canal de entrega (delivery ou pickup) |
consumerName* | string | Nome do consumidor |
document | string | Documento do consumidor |
neighborhood | string | Bairro do endereço de entrega do pedido |
shippingCompanies | array | Lista de transportadoras do pedido |
paymentTypes | array | Lista com tipos de pagamento do pedido |