Hotel das LojasHotel das LojasAPI
Buscar na documentação...Ctrl K

Pedidos

Mudar Status do Pedido

Avança o pedido (pago, aceito, enviado, pronto para retirada, concluído) ou cancela

POST
/v1/pedidos/{id}/status

Escopo

pedidos.escrever
  • Faz exatamente o que o botão do painel faz: registra no histórico (origem api), envia o e-mail de status ao cliente, devolve o estoque no cancelamento, credita ou cancela cashback e dispara os webhooks.
  • Reembolso não é feito pela API porque devolve o dinheiro no meio de pagamento: use o painel.

Pré-condição

O pedido não pode estar cancelado nem reembolsado. Caso contrário:

{
  "erro": {
    "codigo": "pedido_encerrado",
    "mensagem": "Pedido cancelado ou reembolsado não muda mais de situação."
  }
}

Autorização

Authorizationstringobrigatórioheader

Chave da API no formato Bearer hdl_live_.... Crie no painel da loja em Integração › API e webhooks. Saiba mais.

Parâmetros de caminho

idintegerobrigatóriopath

Identificador do pedido.

Corpo da requisição

statusstringobrigatóriobody · application/json

pago, aceito, enviado, pronto_retirada, concluido ou cancelado.

observacaostringbody · application/json

Fica no histórico do pedido.

Resposta

200 — objeto { "dados": {...} } com um Pedido.

Erros possíveis

HTTPcódigoquando
401nao_autenticadoFaltou o cabeçalho Authorization: Bearer <chave>.
401chave_invalidaChave inexistente ou revogada.
403sem_permissaoA chave não tem o escopo exigido pelo endpoint.
404nao_encontradoO recurso não existe nesta loja.
404rota_nao_encontradaEndereço inexistente na API v1.
409mesmo_statusO pedido já está no status pedido.
409pedido_encerradoPedido cancelado ou reembolsado não muda mais.
409estoque_insuficienteSaída maior que o saldo.
409limite_do_planoA loja atingiu o limite de produtos do plano.
409limite_webhooksA loja já tem 10 webhooks.
409conflitoO recurso mudou durante a chamada: consulte e tente de novo.
422validacaoCampos inválidos: veja o objeto "campos".

© Hotel das Lojas · API v1.0 · hoteldaslojas.com.br

POST/pedidos/{id}/status

Este endpoint precisa de uma chave da sua loja com o escopo pedidos.escrever. Ele altera dados de verdade.