VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Pedidos

PUTAtualizar status do pedido

Atualiza o status de um pedido com uma das letras de status.

Use este endpoint para atualizar o status de um pedido. Manter o status em dia informa o cliente sobre o andamento do pedido e serve de controle interno. A resposta devolve o ID do pedido atualizado.

PUT/api/orders/{order_id}Seller

Atualiza o status de um pedido

Cabeçalhos

Authorizationstringobrigatório
Basic Auth. Combinação usuário:senha codificada em Base64 (o e-mail e a chave de API do Seller Center).

Parâmetros de caminho

order_idintegerobrigatório
ID do pedido a atualizar.

Corpo da requisição

statusstringobrigatório
PHGEAYIBDFOCJ
Novo status do pedido (veja a tabela de códigos de status abaixo).

Códigos de status do pedido

CódigoDescrição
PEm preparação
HDespachado
GCancelamento solicitado
EEnviado ao fornecedor
AAguardando aceite do cliente
YPagamento vencido
ICancelado
BAguardando estoque
DPagamento negado
FErro
OAberto
CConcluído
JCancelamento negado
Nota

Outros códigos de status podem existir, dependendo da configuração do e-commerce. Consulte o administrador do e-commerce em caso de dúvida sobre os status disponíveis.

Exemplo de requisição

bash
curl -X PUT "$BASE_URL/api/orders/5131" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "I"
}'

Resposta

200Pedido atualizado (200 OK)
json
{
  "order_id": "5131"
}

Erros

StatusQuandoCorpo de exemplo
405Método não permitido: parâmetros ausentes.{"message": "Method Not Allowed: Missing parameters", "status": 405}
Dica

Ao atualizar um pedido para "Despachado" (H), considere enviar também as informações de entrega em chamadas separadas. Isso ajuda o cliente a acompanhar o pacote.

Importante

A atualização de status costuma disparar notificações ao cliente. Confira se está atualizando para o status correto, para não confundir seus clientes.

Veja também

  • Atualizar produtos do pedido
  • Detalhes do pedido
  • Visão geral de pedidos
Anterior
Atualizar produtos do pedido
Próxima
Pedidos (REST)
Nesta página
  • Códigos de status do pedido
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também