Transportadoras
O cadastro de transportadoras da loja: nome, logotipo e o modelo de link de rastreamento usado nos pedidos e e-mails.
A transportadora (carrier) é o nome de quem leva o pacote: Correios, Jadlog, Loggi, uma frota própria. O cadastro serve a duas coisas: oferecer a lista de transportadoras nas telas de criação de envio e montar o link de rastreamento que o cliente recebe. Basta guardar um modelo de URL com {tracking} onde vai o código de rastreio.
Não confunda com o método de envio. O método é a opção de checkout, com preço e prazo (Métodos de envio). A transportadora é só a identidade de quem entrega. Um método refere-se a uma transportadora pelo code, no campo carrier.
Como funciona
O cliente vê um link de rastreamento quando a loja registra o código de rastreio de um envio. A plataforma procura a transportadora pelo code, troca {tracking} no modelo pelo código e entrega a URL pronta. Transportadora sem modelo gera envio sem link.
Conceitos-chave
code e métodos de envio
O code da transportadora é a ponte com os métodos de envio: o campo carrier de um método guarda esse texto. Por isso a plataforma recusa apagar uma transportadora enquanto algum método a usa: reatribua ou apague os métodos antes.
Ativar e desativar
PATCH .../toggle inverte is_active numa chamada, sem precisar ler o estado antes. É a forma segura de tirar uma transportadora de operação sem perder o cadastro.
Endpoints
| Método e caminho | Para quê | Página |
|---|---|---|
GET /api/v1/admin/carriers | Lista todas, ativas ou não | Listar e consultar |
GET /api/v1/admin/carriers/{id} | Lê uma | Listar e consultar |
POST /api/v1/admin/carriers | Cadastra | Gerenciar |
PUT /api/v1/admin/carriers/{id} | Altera campos | Gerenciar |
PATCH /api/v1/admin/carriers/{id}/toggle | Liga ou desliga | Gerenciar |
DELETE /api/v1/admin/carriers/{id} | Apaga | Gerenciar |
Erros comuns
- Esquecer o
{tracking}no modelo. Sem o marcador, o link sai igual para todos os pacotes. - Tentar apagar uma transportadora em uso. O 409
carrier in usepede para reatribuir os métodos antes. - Repetir o
code. Volta 500, não 409. - Esperar 404 em alterar ou apagar um id inexistente. Essas duas rotas respondem 500 nesse caso.
- Achar que desativar remove o cadastro. A transportadora desativada continua na listagem do administrador.