Áreas de entrega
Lê as áreas de entrega (destinations) da loja pela API legada, compatível com a Venddor 1.0.
Um destino (destination) é uma região geográfica que a loja configura para o frete e para os impostos: um país, alguns estados, cidades, bairros ou faixas de CEP. Na Venddor 1.0 as áreas de entrega eram a base das tabelas de frete. Estas duas rotas só leem as áreas; elas são úteis para um ERP ou um app saber para onde a loja entrega.
Como funciona
Chame Listar áreas para descobrir as áreas e seus ids; use Consultar uma área quando já tiver o id.
Conceitos-chave
Tipo e status
Uma área é de um de dois tipos: shipping (frete) ou tax (imposto). O filtro type da listagem usa exatamente esses dois valores. O status segue as letras do catálogo: A ativa, D desativada, H oculta, N e P pendente.
Ids
O id da área é um UUID em /api/v1.0/destinations. Na forma sem versão (/api/destinations) os ids saem como números decimais dentro de uma string.
Endpoints
| Método | Caminho | Para quê | Autenticação | Página |
|---|---|---|---|---|
| GET | /api/v1.0/destinations | Lista as áreas de entrega | Administrador | Ler áreas |
| GET | /api/v1.0/destinations/{id} | Consulta uma área | Administrador | Ler áreas |
Erros comuns
- Esperar paginação. Não há
pagenemitems_per_page: a resposta traz todas as áreas. - Consultar com um id que não é UUID. Em
/api/v1.0/destinations/{id}isso devolve 500, não 404. - Tentar criar ou alterar áreas. Esta API não escreve: a manutenção das áreas é feita no painel da loja.