API atual/Referência completa/Frete: áreas e retirada

Serviços de transportadora

Lista o catálogo de serviços de transportadoras que a plataforma conhece, como PAC e SEDEX dos Correios.

Um serviço de transportadora é uma modalidade de entrega oferecida por uma transportadora: PAC e SEDEX (Correios), Jadlog .Com, Frenet, SimFrete. Ao criar um método de envio da loja, você escolhe o serviço que ele usa. Esta rota entrega o catálogo para montar essa escolha.

Ler exige view_shipping ou manage_shipping. O catálogo é somente leitura.

Listar serviços

Devolve todos os serviços, ordenados por transportadora e nome, sem paginação.

GET/api/v1/admin/shipping-servicesAdmin

Lista os serviços de transportadoras

Parâmetros de consulta

carrierstring

Código da transportadora (correios, jadlog, frenet, simfrete). Comparação exata, em minúsculas. Um código que não existe devolve lista vazia.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/shipping-services?carrier=correios" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Serviços retornados

json

{
  "services": [
    { "id": "4527b741-ebad-4d99-89b9-2e28b2b03e35", "carrier": "correios", "code": "pac", "name": "PAC", "status": "A" },
    { "id": "f683a07a-96df-452d-b62f-aefd3963945e", "carrier": "correios", "code": "sedex", "name": "SEDEX", "status": "A" },
    { "id": "b106bb38-685f-4352-b197-5420f14f080e", "carrier": "correios", "code": "03298", "name": "PAC Contrato", "status": "A" }
  ],
  "total": 3
}

Sem resultado, services vem null e total vem 0.

Campos da resposta

servicesarray

Serviços.

totalinteger

Quantidade devolvida.

services[].iduuid

Id do serviço.

services[].carrierstring

Transportadora: correios, jadlog, frenet ou simfrete (conforme a loja).

services[].codestring

Código do serviço na transportadora. Nos Correios, pac e sedex são os genéricos; os códigos numéricos (03298) são os serviços de contrato.

services[].namestring

Nome para exibição.

services[].statusstring

AD

A ativo, D desativado.

Erros

Status	Quando	Corpo
401 / 403	Sem token ou sem privilégio	`{"error":"insufficient privileges", ...}`
500	Falha interna	`{"error":"failed to list shipping services","detail":"..."}`

Veja também