API Reference
Log In
API Reference

Status do pedido

Este hook envia atualizações de status do pedido.

CampoTipoDescrição
orderNumberstringIdentificador do pedido
statusstringNovo status definido
externalStatusstringStatus recebido de canais externos (canal de venda, transportadora, entre outros)
trackingCodestringIdentificador principal da loja
extrasobjectObjeto contendo informações complementares do pedido
eventDatestringData em que o status foi definido.

Lista de status

StatusDescrição
WaveInProgressProcesso de separação iniciado
WaveCompletedProcesso de separação concluído
WaveCompletedWithErrorsProcesso de separação concluído com ocorrências
CheckoutInProgressProcesso de conferência iniciado
CheckoutCompletedProcesso de conferência concluído
InvoicePendingFaturamento pendente
InvoicingInProgressFaturamento solicitado, aguardando liberação
InvoicedFaturamento concluído
ShipmentInProgressProcesso de expedição em andamento
ShipmentCompletedProcesso de expedição concluído
ShippingStartedEnviado para transportadora
ShippingDeliveredEntregue pela transportadora
ShippingRejectedDevolvido pela transportadora
ShippingStrayedNão entregue para o destinatário (extraviado)
ShippingCancelledSolicitação de entrega cancelada
ShippingRejectedRejeitado pelo cliente ou pela transportadora

Exemplo do corpo enviado para api em caso de alteração no status do pedido

{
  "orderNumber": "12345-01",
  "status": "Invoiced",
	"externalStatus": "invoiced",
  "trackingCode": "store-01",
	"extras": {},
	"eventDate": "2025-01-01T10:01:59.000Z"
}