Atualizar status de um pedido

PATCH /v1/orders/{orderNumber}/status

Header

• Authorization: Basic Auth contendo a chave pública e secreta disponibilizadas para o cliente.
  • Exemplo: Basic <base64-encoded-credentials>
• x-contractAccountId: Identificador da conta do contrato do cliente.
  • Exemplo: x-contractAccountId: 9f36a666-acd5-4987-a47f-3de247f65d82

Exemplo de Autorização

Para gerar o valor de Authorization, você precisa codificar suas credenciais (public_key:secret_key) em base64. Por exemplo, se sua chave pública for public_key e sua chave secreta for secret_key, você deve codificar public_key:secret_key em base64.

echo -n 'public_key:secret_key' | base64

Parâmetros da URL

• orderNumber (int, obrigatório): Número do pedido a ser atualizado.

Corpo da Requisição

O corpo da requisição deve ser um objeto com a seguinte propriedade:

Campo	Tipo	Nullable	Descrição
status	string	Não	Novo status do pedido. Deve ser um dos valores válidos do enum OrderStatusEnum

Valores válidos para status

Status	Valor	Descrição
CartCreated	1	Carrinho criado
OrderCreated	100	Pedido criado
PaymentPending	200	Pagamento pendente
PaymentInProgress	230	Pagamento em processamento
PaymentError	250	Erro no pagamento
PaymentApproved	300	Pagamento aprovado
OrderInvoiced	350	Pedido faturado
OrderBeingPrepared	400	Pedido em preparação
ReadyForPickupOrDelivery	500	Pronto para retirada ou entrega
Shipped	600	Enviado
Delivered	700	Entregue
OrderCancellationAnalysis	750	Análise de cancelamento
OrderCancelled	800	Pedido cancelado
DeliveryFailed	900	Falha na entrega
OrderReturned	1000	Pedido devolvido
RefundInProgress	1100	Reembolso em andamento
RefundCompleted	1200	Reembolso concluído
OrderUpdated	1300	Pedido atualizado

Exemplo de Corpo da Requisição

{
  "status": "PaymentApproved"
}

Respostas

• 200: Retorna sucesso da operação. A resposta incluirá um ID de transação para rastreamento.
• 400: Retorna erro de requisição inválida. Isso geralmente ocorre devido a dados de entrada mal formatados ou faltando.
• 500: Retorna erro interno do servidor. Indica problemas no processamento da requisição no servidor.

Exemplo de Resposta para Sucesso (200)

{
  "transactionId": "5f1d265b-d836-40f7-84dd-7ded9804039d"
}

Exemplo de notificação de atualização de status (webhook)

{
  "operationId": "5f1d265b-d836-40f7-84dd-7ded9804039d",
  "relatedEntity": 0,
  "eventType": 133,
  "data": {
    "id": "19cc15c4-004d-4aa9-b058-08dd4f63c168",
    "status": "PaymentApproved",
    "orderStatusRegistry": [
      {
        "orderId": "19cc15c4-004d-4aa9-b058-08dd4f63c168",
        "status": 300,
        "id": "fdf98546-a72a-49c7-466b-08dd559ae931",
        "contractAccountId": "e9a2fca6-198f-4b4a-a183-2356ef6562f5",
        "createdAt": "2025-02-25T12:50:28.6609626",
        "updatedAt": null
      }
    ]
  },
  "contractAccountId": "e9a2fca6-198f-4b4a-a183-2356ef6562f5"
}