Atualizar status de um pedido

PATCH /v1/orders/{orderNumber}/status

Header

• Authorization: Basic Auth contendo a chave publica 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

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	Descrição
CART_CREATED	Carrinho criado
ORDER_CREATED	Pedido criado
PAYMENT_PENDING	Pagamento pendente
PAYMENT_ERROR	Erro no pagamento
PAYMENT_APPROVED	Pagamento aprovado
ORDER_INVOICED	Pedido faturado
ORDER_BEING_PREPARED	Pedido em preparação
READY_FOR_PICKUP_OR_DELIVERY	Pronto para retirada ou entrega
SHIPPED	Enviado
DELIVERED	Entregue
ORDER_CANCELLATION_ANALYSIS	Análise de cancelamento de pedido
ORDER_CANCELLED	Pedido cancelado
DELIVERY_FAILED	Falha na entrega
ORDER_RETURNED	Pedido devolvido
REFUND_IN_PROGRESS	Reembolso em andamento
REFUND_COMPLETED	Reembolso concluído

Exemplo de Corpo da Requisição

{
  "status": "PAYMENT_APPROVED"
}

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": 25,
  "data": {
    "id": "19cc15c4-004d-4aa9-b058-08dd4f63c168",
    "status": "PAYMENT_APPROVED",
    "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"
}