Saltar para o conteúdo
ShopentlyLearn
Português (Portugal)

Pedidos

Leia resumos e detalhes de pedidos e atualize o estado do pedido ou do pagamento.

Operações

GETListar · Estados — Pedidos/api/v1/order-statuses

Exemplo de requisiçãoExemplo de resposta

GETListar — Pedidos/api/v1/orders

Exemplo de requisiçãoExemplo de resposta

GETObter — Pedidos/api/v1/orders/{order_id}

Exemplo de requisiçãoExemplo de resposta

PATCHAtualizar · Estado do pagamento — Pedidos/api/v1/orders/{order_id}/payment-status

Exemplo de requisiçãoExemplo de resposta

PATCHAtualizar · Estado — Pedidos/api/v1/orders/{order_id}/status

Exemplo de requisiçãoExemplo de resposta

Como funciona

A lista e os detalhes dos pedidos incluem delivery.dates. As datas YYYY-MM-DD são previstas e não confirmam o envio. As datas atuais têm prioridade; pedidos antigos usam a estimativa guardada. Valores apagados ou desconhecidos são null. Os detalhes incluem também todas as linhas e imagens dos produtos.

Obtenha identificadores de estado válidos em /api/v1/order-statuses. O estado do pedido e o estado do pagamento usam endpoints PATCH e permissões separados. Alterar o estado de pagamento registado não cobra um cartão nem emite um reembolso por um provedor de pagamentos.

Escritas seguras

Permissões e planos

delivery.dates: planned_dispatch_on, dispatch_timezone, estimated_delivery_from, estimated_delivery_to. Datas de envio e entrega: YYYY-MM-DD; null. Fuso horário do envio: IANA.

Encomenda · Totais

Os montantes e taxas vêm da encomenda guardada, incluindo correções das linhas. Dados históricos em falta são null e não são substituídos pelas taxas atuais do catálogo. Os montantes continuam a ser textos decimais.

  • tax_country_code · País fiscal · Dados guardados da encomenda · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · Uma unidade · Antes dos descontos; lines[].original_total_* · Antes dos descontos; lines[].total_* · Após os descontos.
  • lines[].discount_* · Descontos; manual_discount · Desconto manual; percentage "10" = 10%.
  • delivery.net / tax / gross · Após os descontos; delivery.original_* · Antes dos descontos; delivery.discount_* · Descontos.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Desconhecido: null; zero conhecido: 0.
  • totals · Totais; tax_breakdown.groups · Grupos fiscais; Imposto não atribuído = order.tax − Σ groups.tax; ±.

A lista devolve resumos. Obtenha GET /api/v1/orders/{order_id} para cada resultado para exportar o detalhe financeiro completo. As repetições GET são limitadas e respeitam Retry-After. A exportação por data de criação não sincroniza correções posteriores.

payment.amount é o total da encomenda. O estado do pagamento não determina montantes pagos, reembolsados ou em dívida.

Esquemas de dados

Guias

Exportar encomendas