API atual/Referência completa/Frete e entrega

Transportadoras

Lista as transportadoras ativas e monta o link de rastreio de um código no site da transportadora.

Uma transportadora (carrier) é a empresa que leva o pacote: Correios, Loggi, Total Express e outras. Cada uma tem um modelo de link de rastreio. Estas rotas dão ao front-end o nome, o logotipo e o link correto para o cliente acompanhar o pedido no site da transportadora.

Lista de transportadoras

GET/api/v1/storefront/carriersPública

Lista as transportadoras ativas

Lista as transportadoras ativas cadastradas na loja, na ordem de posição. Não exige token.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/carriers"

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:44.039041Z",
      "updated_at": "2026-06-26T01:32:21.600412Z"
    }
  ],
  "total": 1
}

Campos da resposta

carriersobject[]

Transportadoras ativas.

carriers[].iduuid

Id.

carriers[].namestring

Nome para exibir.

carriers[].codestring

Código estável.

carriers[].tracking_url_templatestring

Modelo do link, com {tracking} no lugar do código de rastreio.

carriers[].logo_urlstring

Logotipo (caminho relativo à loja ou URL).

carriers[].is_activeboolean

Sempre true nesta rota.

carriers[].positioninteger

Posição de exibição.

carriers[].created_atstring

RFC 3339.

carriers[].updated_atstring

RFC 3339.

totalinteger

Quantidade de transportadoras.

Erros

Status	Quando	Corpo
500	Falha ao listar.	`{"error":"failed to list carriers","detail":"..."}`

Link de rastreio

GET/api/v1/storefront/carriers/{code}/tracking-urlPública

Link de rastreio na transportadora

Monta o link de rastreio de um código na página da transportadora.

Parâmetros de caminho

codestringobrigatório

Código da transportadora (code de Lista de transportadoras), como correios_sedex.

Parâmetros de consulta

numberstringobrigatório

Código de rastreio do pacote.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/carriers/correios_sedex/tracking-url?number=AB123456789BR"

Resposta

200Link montado

json

{
  "carrier": {
    "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
  },
  "tracking_url": "https://rastreamento.correios.com.br/app/index.php?objetos=AB123456789BR"
}

Campos da resposta

carrierobject

A transportadora (mesmos campos da lista).

tracking_urlstring

O link pronto, com o código no lugar de {tracking}.

Erros

Status	Quando	Corpo
400	Sem o parâmetro `number`.	`{"error":"tracking number is required"}`
404	Transportadora com esse `code` inexistente.	`{"error":"carrier not found","detail":"carrier not found by code: zzz"}`

Veja também

Transportadoras

Lista as transportadoras ativas e monta o link de rastreio de um código no site da transportadora.

Lista de transportadoras

GET/api/v1/storefront/carriersPública

Lista as transportadoras ativas

Lista as transportadoras ativas cadastradas na loja, na ordem de posição. Não exige token.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/carriers"

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:44.039041Z",
      "updated_at": "2026-06-26T01:32:21.600412Z"
    }
  ],
  "total": 1
}

Campos da resposta

carriersobject[]

Transportadoras ativas.

carriers[].iduuid

Id.

carriers[].namestring

Nome para exibir.

carriers[].codestring

Código estável.

carriers[].tracking_url_templatestring

Modelo do link, com {tracking} no lugar do código de rastreio.

carriers[].logo_urlstring

Logotipo (caminho relativo à loja ou URL).

carriers[].is_activeboolean

Sempre true nesta rota.

carriers[].positioninteger

Posição de exibição.

carriers[].created_atstring

RFC 3339.

carriers[].updated_atstring

RFC 3339.

totalinteger

Quantidade de transportadoras.

Erros

Status	Quando	Corpo
500	Falha ao listar.	`{"error":"failed to list carriers","detail":"..."}`

Link de rastreio

GET/api/v1/storefront/carriers/{code}/tracking-urlPública

Link de rastreio na transportadora

Monta o link de rastreio de um código na página da transportadora.

Parâmetros de caminho

codestringobrigatório

Código da transportadora (code de Lista de transportadoras), como correios_sedex.

Parâmetros de consulta

numberstringobrigatório

Código de rastreio do pacote.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/carriers/correios_sedex/tracking-url?number=AB123456789BR"

Resposta

200Link montado

json

{
  "carrier": {
    "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
  },
  "tracking_url": "https://rastreamento.correios.com.br/app/index.php?objetos=AB123456789BR"
}

Campos da resposta

carrierobject

A transportadora (mesmos campos da lista).

tracking_urlstring

O link pronto, com o código no lugar de {tracking}.

Erros

Status	Quando	Corpo
400	Sem o parâmetro `number`.	`{"error":"tracking number is required"}`
404	Transportadora com esse `code` inexistente.	`{"error":"carrier not found","detail":"carrier not found by code: zzz"}`