Frete

Listar Entrega Local

Taxas por região e outras opções de entrega ou retirada

GET

/v1/frete/entrega-local

Escopo

frete.ler

taxa_regiao: entrega própria por bairro ou região. outra_opcao: pontos combinados com o cliente; o link_direto (também usado no QR Code) abre a loja com a opção escolhida.

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).

tipostringquery

taxa_regiao ou outra_opcao.

Resposta

200 — objeto { "dados": ... } (veja o exemplo).

Erros possíveis

HTTP	código	quando
`401`	`nao_autenticado`	Faltou o cabeçalho Authorization: Bearer <chave>.
`401`	`chave_invalida`	Chave inexistente ou revogada.
`403`	`sem_permissao`	A chave não tem o escopo exigido pelo endpoint.

import os, requests resposta = requests.get( "https://api.hoteldaslojas.com.br/v1/frete/entrega-local", headers={"Authorization": f"Bearer {os.environ['HDL_CHAVE']}"}, timeout=30, ) resposta.raise_for_status() print(resposta.json()["dados"])

<?php $ch = curl_init('https://api.hoteldaslojas.com.br/v1/frete/entrega-local'); curl_setopt_array($ch, [ CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('HDL_CHAVE')], ]); $resposta = json_decode(curl_exec($ch), true); $status = curl_getinfo($ch, CURLINFO_HTTP_CODE); curl_close($ch); print_r($resposta);

{ "dados": [ { "id": 75, "nome": "Centro", "valor": 8.0, "tipo": "taxa_regiao", "link_direto": null }, { "id": 77, "nome": "Retirada no shopping", "valor": 0.0, "tipo": "outra_opcao", "link_direto": "https://demo73.hoteldaslojas.com.br/?local=77" } ], "paginacao": { "pagina": 1, "por_pagina": 20, "total": 2, "paginas": 1 } }

{ "erro": { "codigo": "sem_permissao", "mensagem": "Esta chave não tem o escopo \"pedidos.ler\". Crie uma chave com esse escopo no painel da loja (Integração › API).", "request_id": "req_95f4a872c180063c" } }