Atualizar dados de um pedido realizado

PUT /v1/orders/{orderNumber}

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 único objeto com as seguintes propriedades:

Campo	Tipo	Nullable	Descrição
finalOrderPrice	decimal	Sim	Valor total do pedido
skusToUpsert	array	Não	Lista de SKUs para criação/atualização no pedido
skusToUpsert.skuExternalReference	string	Não	Referência externa do SKU para identificação e atualização na base de dados
skusToUpsert.quantity	decimal	Sim	Nova quantidade de SKUs no pedido
skusToUpsert.price	decimal	Sim	Preço customizado do item
skusToUpsert.unitOfMeasure	number	Sim	Unidade de medida (1 - Un, 2 - Kg, 3 - G, 4 - Mg)

Exemplo de Corpo da Requisição

{
  "skusToUpsert": [
    {
      "skuExternalReference": "38370",
      "quantity": 4,
      "price": 4.43,
      "unitOfMeasure": 1
    },
    {
      "skuExternalReference": "2027",
      "quantity": 10,
      "unitOfMeasure": 1
    }
  ],
  "finalOrderPrice": 15.2
}

Respostas

• 200: Retorna sucesso da operação confirmando a solicitação de alteração.
• 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.

Notificação via webhook

Após o processamento da atualização, uma notificação é enviada via webhook com eventType: 14 (Order_Updated) contendo os dados completos do pedido atualizado, incluindo informações de pagamento, itens, endereço de entrega e política de envio.