VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa

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.

Pontos-chave
  • Uma loja nova costuma vir com as transportadoras comuns do Brasil já cadastradas (Correios, Jadlog, Loggi, Total Express e outras). Você pode desativar, editar ou acrescentar.
  • code é único. Repetir devolve 500 com a causa em detail.
  • is_active: false tira a transportadora das listas públicas, mas ela continua cadastrada.
  • Não é possível apagar uma transportadora que algum método de envio ainda usa (409).
  • O modelo de rastreamento usa o marcador {tracking}.
  • O registro só guarda nome, logotipo e link: não calcula frete nem integra com a transportadora.

Como funciona

Cadastrar→Ativar→Usar em métodos e envios→Desativar ou apagar

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 caminhoPara quêPágina
GET /api/v1/admin/carriersLista todas, ativas ou nãoListar e consultar
GET /api/v1/admin/carriers/{id}Lê umaListar e consultar
POST /api/v1/admin/carriersCadastraGerenciar
PUT /api/v1/admin/carriers/{id}Altera camposGerenciar
PATCH /api/v1/admin/carriers/{id}/toggleLiga ou desligaGerenciar
DELETE /api/v1/admin/carriers/{id}ApagaGerenciar

Erros comuns

  1. Esquecer o {tracking} no modelo. Sem o marcador, o link sai igual para todos os pacotes.
  2. Tentar apagar uma transportadora em uso. O 409 carrier in use pede para reatribuir os métodos antes.
  3. Repetir o code. Volta 500, não 409.
  4. Esperar 404 em alterar ou apagar um id inexistente. Essas duas rotas respondem 500 nesse caso.
  5. Achar que desativar remove o cadastro. A transportadora desativada continua na listagem do administrador.

Próximos passos

Listar e consultar
Veja as transportadoras cadastradas.
Gerenciar
Cadastre, altere, ative ou apague.
Métodos de envio
Onde a transportadora vira opção de checkout.
Anterior
Impostos de importação
Próxima
Listar e consultar transportadoras
Nesta página
  • Como funciona
  • Conceitos-chave
  • code e métodos de envio
  • Ativar e desativar
  • Endpoints
  • Erros comuns
  • Próximos passos