API atual/Referência completa/Frete e entrega

Métodos de envio

Lista os métodos de envio ativos da loja, na ordem definida pelo administrador.

Use para mostrar "formas de entrega que a loja oferece" (por exemplo, na página de política de frete). Não use para calcular preço: o valor de um método depende do destino e do carrinho, e quem faz a conta é Cotar frete.

GET/api/v1/storefront/shipping/methodsPública

Lista os métodos de envio ativos

Não exige token. Devolve só os métodos ativos, na ordem de posição que o administrador definiu. Métodos que a customização da loja desligou não aparecem.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/shipping/methods"

Resposta

200Métodos ativos

json

{
  "methods": [
    {
      "id": "85e87a54-dcee-4947-8cfa-f6406f2f3cbb",
      "display_id": 53,
      "name": "Motoboy",
      "code": "motoboy_msdxztz7",
      "carrier": "manual",
      "rate_calculation": "M",
      "delivery_time": "30 min",
      "status": "A",
      "min_weight": 0,
      "max_weight": 0,
      "free_shipping_threshold": 0,
      "flat_rate": 500,
      "estimated_days": 0,
      "free_shipping": false,
      "is_address_required": false,
      "tax_ids": "",
      "usergroup_ids": "",
      "icon_url": "",
      "surcharge": 0,
      "surcharge_percent": 0,
      "use_for_all_vendors": false,
      "position": 0,
      "created_at": "2026-08-04T00:51:15.019077Z",
      "updated_at": "2026-09-15T19:47:24.604493Z",
      "company_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36"
    }
  ],
  "total": 1
}

Campos da resposta

methodsobject[]

Métodos ativos, por posição.

methods[].iduuid

Id do método.

methods[].display_idinteger

Número curto.

methods[].namestring

Nome para exibir.

methods[].codestring

Código estável (standard, correios_sedex...).

methods[].carrierstring

Transportadora ou origem: correios, jadlog, frenet, simfrete, manual.

methods[].carrier_service_codestring

Produto contratado na transportadora (por exemplo 03220). Ausente quando não há.

methods[].rate_calculationstring

MR

M preço manual (tabela por área) ou R em tempo real (consulta à transportadora).

methods[].descriptionstring

Descrição. Ausente quando não há.

methods[].delivery_timestring

Texto de prazo, como 3-5 dias úteis.

methods[].statusstring

Sempre A (ativo) nesta rota.

methods[].min_weightnumber

Peso mínimo do pedido em kg. 0 sem mínimo.

methods[].max_weightnumber

Peso máximo em kg. 0 sem máximo.

methods[].flat_rateinteger

Tarifa fixa antiga, em centavos. Em desuso: o preço real vem da cotação.

methods[].free_shipping_thresholdinteger

Limite antigo de frete grátis, em centavos. Em desuso.

methods[].free_shippingboolean

O método pode ser grátis por promoção.

methods[].is_address_requiredboolean

Exige endereço de entrega completo.

methods[].use_for_all_vendorsboolean

true quando vale para todos os sellers por padrão.

methods[].company_iduuid

Seller dono do método. Ausente quando o método é da loja inteira.

methods[].positioninteger

Posição de exibição.

methods[].icon_urlstring

Ícone. Pode ser vazio.

methods[].created_atstring

RFC 3339.

methods[].updated_atstring

RFC 3339.

methods[].tax_ids, usergroup_ids, surcharge, surcharge_percent, config, service_paramsmixed

Campos de configuração interna do método, devolvidos como estão no cadastro. Não dependa deles.

totalinteger

Quantidade de métodos devolvidos.

Erros

Status	Quando	Corpo
500	Falha ao ler os métodos.	`{"error":"failed to get shipping methods","detail":"..."}`

Veja também

Métodos de envio

Lista os métodos de envio ativos da loja, na ordem definida pelo administrador.

GET/api/v1/storefront/shipping/methodsPública

Lista os métodos de envio ativos

Não exige token. Devolve só os métodos ativos, na ordem de posição que o administrador definiu. Métodos que a customização da loja desligou não aparecem.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/shipping/methods"

Resposta

200Métodos ativos

json

{
  "methods": [
    {
      "id": "85e87a54-dcee-4947-8cfa-f6406f2f3cbb",
      "display_id": 53,
      "name": "Motoboy",
      "code": "motoboy_msdxztz7",
      "carrier": "manual",
      "rate_calculation": "M",
      "delivery_time": "30 min",
      "status": "A",
      "min_weight": 0,
      "max_weight": 0,
      "free_shipping_threshold": 0,
      "flat_rate": 500,
      "estimated_days": 0,
      "free_shipping": false,
      "is_address_required": false,
      "tax_ids": "",
      "usergroup_ids": "",
      "icon_url": "",
      "surcharge": 0,
      "surcharge_percent": 0,
      "use_for_all_vendors": false,
      "position": 0,
      "created_at": "2026-08-04T00:51:15.019077Z",
      "updated_at": "2026-09-15T19:47:24.604493Z",
      "company_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36"
    }
  ],
  "total": 1
}

Campos da resposta

methodsobject[]

Métodos ativos, por posição.

methods[].iduuid

Id do método.

methods[].display_idinteger

Número curto.

methods[].namestring

Nome para exibir.

methods[].codestring

Código estável (standard, correios_sedex...).

methods[].carrierstring

Transportadora ou origem: correios, jadlog, frenet, simfrete, manual.

methods[].carrier_service_codestring

Produto contratado na transportadora (por exemplo 03220). Ausente quando não há.

methods[].rate_calculationstring

MR

M preço manual (tabela por área) ou R em tempo real (consulta à transportadora).

methods[].descriptionstring

Descrição. Ausente quando não há.

methods[].delivery_timestring

Texto de prazo, como 3-5 dias úteis.

methods[].statusstring

Sempre A (ativo) nesta rota.

methods[].min_weightnumber

Peso mínimo do pedido em kg. 0 sem mínimo.

methods[].max_weightnumber

Peso máximo em kg. 0 sem máximo.

methods[].flat_rateinteger

Tarifa fixa antiga, em centavos. Em desuso: o preço real vem da cotação.

methods[].free_shipping_thresholdinteger

Limite antigo de frete grátis, em centavos. Em desuso.

methods[].free_shippingboolean

O método pode ser grátis por promoção.

methods[].is_address_requiredboolean

Exige endereço de entrega completo.

methods[].use_for_all_vendorsboolean

true quando vale para todos os sellers por padrão.

methods[].company_iduuid

Seller dono do método. Ausente quando o método é da loja inteira.

methods[].positioninteger

Posição de exibição.

methods[].icon_urlstring

Ícone. Pode ser vazio.

methods[].created_atstring

RFC 3339.

methods[].updated_atstring

RFC 3339.

methods[].tax_ids, usergroup_ids, surcharge, surcharge_percent, config, service_paramsmixed

Campos de configuração interna do método, devolvidos como estão no cadastro. Não dependa deles.

totalinteger

Quantidade de métodos devolvidos.

Erros

Status	Quando	Corpo
500	Falha ao ler os métodos.	`{"error":"failed to get shipping methods","detail":"..."}`