API atual/Referência completa/Expedição e retirada

GETTransportadoras da loja

Lista as transportadoras ativas da loja, usadas no formulário de envio do seller.

A loja mantém um cadastro de transportadoras (Correios, Loggi, Jadlog...) com o modelo do link de rastreio de cada uma. Quando o seller cria um envio para um pedido, ele escolhe uma delas. Esta rota devolve as transportadoras ativas, na ordem de exibição. O seller não cadastra transportadoras: quem faz isso é o administrador da loja. Requer o módulo de fluxo de status de pedidos (order-status-flow) ligado.

GET/api/v1/vendor/shipment-carriersSeller

Lista as transportadoras ativas da loja

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/shipment-carriers" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Transportadoras

json

{
  "carriers": [
    {
      "id": "dcd17e6e-f428-4c84-bdb9-14800393ed51",
      "name": "Correios SEDEX",
      "code": "correios_sedex",
      "tracking_url_template": "https://rastreamento.correios.com.br/app/index.php?objetos={tracking}",
      "logo_url": "/carriers/correios.svg",
      "is_active": true,
      "position": 2,
      "created_at": "2026-03-25T04:08:44Z",
      "updated_at": "2026-06-26T01:32:21Z"
    }
  ],
  "total": 1
}

Campos da resposta

carriersarray

Transportadoras ativas.

iduuid

Id da transportadora.

namestring

Nome de exibição.

codestring

Código estável (correios_sedex). Use-o como carrier ao despachar.

tracking_url_templatestring

Modelo do link de rastreio. Troque {tracking} pelo código do objeto.

logo_urlstring

Logotipo (caminho ou URL).

is_activeboolean

Sempre true nesta rota.

positioninteger

Ordem de exibição.

created_at, updated_atstring

Criação e alteração, RFC 3339.

totalinteger

Quantidade.

Erros

Status	Quando	Corpo de exemplo
401	Sem cabeçalho `Authorization`, ou token inválido ou expirado.	`{"error":"invalid or expired token"}`
403	O token não é de um usuário seller (por exemplo, é um token de administrador).	`{"error":"insufficient permissions"}`
403	Sem privilégio de pedidos, ou o módulo `order-status-flow` está desligado.	`{"error":"module_disabled","module":"order-status-flow"}`
500	Falha ao consultar.	`{"error":"failed to list carriers"}`

Veja também