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

Pedidos

Listar Pedidos

Lista os pedidos com filtros por status, data e cliente

GET
/v1/pedidos

Escopo

pedidos.ler
Para importar pedidos novos num ERP: guarde o maior id importado e chame com id_maior_que={id}&ordem=id. Ou use o webhook pedido.criado.

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 consulta

paginaintegerquery

Página (padrão 1).

por_paginaintegerquery

Itens por página, de 1 a 100 (padrão 20).

statusstringquery

Um ou mais, separados por vírgula: pendente, pago, aceito, enviado, pronto_retirada, concluido, cancelado, reembolsado.

situacao_pagamentostringquery

pendente, em_analise, aprovado, recusado, estornado, cancelado.

desdestringquery

Compras a partir desta data.

atestringquery

Compras até esta data.

cliente_idintegerquery

Pedidos de um cliente.

emailstringquery

Pedidos deste e-mail.

id_maior_queintegerquery

Só pedidos com número maior (importação incremental).

ordemstringquery

id (mais antigos primeiro) ou padrão (mais novos primeiro).

incluir_itensbooleanquery

true traz itens, notas e histórico em cada pedido.

Resposta

200 — objeto { "dados": [...], "paginacao": {...} } com uma lista de Pedido e a paginação.

Erros possíveis

HTTPcódigoquando
400json_invalidoO corpo não é um JSON válido (confira também a codificação UTF-8).
400parametro_invalidoUm parâmetro de consulta tem formato errado (ex.: data).
401nao_autenticadoFaltou o cabeçalho Authorization: Bearer <chave>.
401chave_invalidaChave inexistente ou revogada.
403sem_permissaoA chave não tem o escopo exigido pelo endpoint.

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

GET/pedidos

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