SYSLED DevelopersTodos os métodos
POST

shop.frete.calcular

Calcula tarifas compatíveis com o carrinho e destino, combinando perfis quando necessário.

Grupo: ShopRevisão: Escopo recomendado: shop.frete.calcular
Exemplos seguros e fictícios. O domínio example.invalid e a credencial demonstrativa abaixo não funcionam. Use o token real somente no servidor da sua integração e nunca o inclua em páginas públicas.

Parâmetros

Parâmetros aceitos por shop.frete.calcular
CampoTipoObrigatoriedadeDescriçãoExemplo fictício
cepstringObrigatórioCEP de destino; pontuação é normalizada. Envie 8 dígitos."01001000"
itensarray<object> | string JSONObrigatórioLista de SKU e quantidade. Este método aceita array JSON ou string JSON; string inválida vira lista vazia.[{"sku":"DEMO-01","qtd":2}]
itens[].skustringum dos dois obrigatórioSKU do produto. Em cada item informado, envie sku OU codigo; sku tem precedência quando ambos são preenchidos."DEMO-01"
itens[].codigostringum dos dois obrigatórioAlternativa a itens[].sku. Em cada item informado, é necessário identificar o produto por sku OU codigo."DEMO-01"
itens[].qtdintegerOpcionalQuantidade; quantidade é alias; valores são arredondados para baixo e limitados ao mínimo 1.2

Exemplos fictícios

Os exemplos documentam o formato; eles não executam nenhuma operação.

Requisição

cURL demonstrativo
curl --request POST \
  'https://example.invalid/api/v1/CREDENCIAL_FICTICIA_SEM_VALOR/shop.frete.calcular' \
  --header 'Content-Type: application/json' \
  --data '{"cep":"01001000","itens":[{"sku":"DEMO-01","qtd":2}]}'
Corpo JSON
{
  "cep": "01001000",
  "itens": [
    {
      "sku": "DEMO-01",
      "qtd": 2
    }
  ]
}
Resposta HTTP 200
{
  "ok": true,
  "method": "shop.frete.calcular",
  "result": {
    "cep": "01001000",
    "uf": "SP",
    "opcoes": [
      {
        "opcao_ids": [
          "55555555-5555-4555-8555-555555555555"
        ],
        "nome": "Entrega padrão",
        "valor_cents": 900,
        "prazo_min_dias": 2,
        "prazo_max_dias": 4,
        "id": "55555555-5555-4555-8555-555555555555",
        "valor": 9,
        "entrega_estimada": null
      }
    ],
    "retirada": null,
    "entrega_local": null,
    "origem": {
      "cep": "01001000",
      "uf": "SP"
    },
    "motivo": null,
    "itens_sem_frete": [],
    "peso_incompleto": false
  }
}

Erros

Condições de erro específicas de shop.frete.calcular
HTTPCódigoCondição
403TOKEN_NO_COMPANYToken sem empresa associada.

Consulte também os erros globais e limites.

Observações