VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Métodos de frete

Campos de métodos de envio

Referência de todas as propriedades de um método de envio: nomes, descrições, valores padrão e valores aceitos.

Um método de envio tem várias propriedades, representadas por campos. Esses campos controlam como as opções de frete são calculadas, exibidas e aplicadas aos pedidos.

Importante

A tabela abaixo mostra todos os campos aceitos em métodos de envio. Os campos obrigatórios estão marcados com *. Qualquer campo que não esteja na tabela é ignorado se for enviado em uma requisição.

Referência dos campos de método de envio

Nome do campoDescriçãoValor padrãoValores aceitos
shipping*Nome do método de envionenhumstring
company_idID da empresaID da empresa padrãointeger
delivery_timePrazo de entrega''string
iconÍcone do método de envio{}Veja Main pair
localizationTexto com os IDs de localização separados por vírgula''string
max_weightPeso máximo que pode ser entregue0.00float
min_weightPeso mínimo que pode ser entregue0.00float
positionPosição na lista (a documentação original descreve como "posição do pagamento na lista de pagamentos")0integer
rate_calculationCálculo da tarifaMM para manual, R para tempo real
ratesTarifas{'rate_value': {'C': {}, 'I': {}, 'W': {}},Array de tarifas
service_idID do serviço de entrega0ID válido de serviço de entrega
service_paramsParâmetros do serviço de entrega{}Objeto JSON
shipping_idID do método de envioDefinido automaticamenteinteger
statusStatus do método de envioAA para ativo, D para desativado, H para oculto
tax_idsIDs dos impostos''Texto com os IDs de imposto separados por vírgula
usergroup_idsIDs dos grupos de usuários'0'Texto com os IDs de grupo de usuários separados por vírgula

Exemplo de objeto de método de envio

Dica

Ao criar um método de envio novo, só o campo shipping é obrigatório. Os demais campos usam os valores padrão quando não são informados.

Sobre o cálculo da tarifa

Em rate_calculation, use M para tarifas de frete definidas manualmente (configuradas no objeto rates) ou R para tarifas em tempo real, vindas de serviços de entrega externos (exige um service_id válido).

Veja também

Métodos de envio
As rotas dos métodos de envio.
Endpoints
As URLs da API de métodos de envio.
Anterior
Endpoints de métodos de envio
Próxima
Paginação de métodos de envio
Nesta página
  • Referência dos campos de método de envio
  • Exemplo de objeto de método de envio
  • Veja também
json
{
  "shipping": "Standard Ground Shipping",
  "company_id": 1,
  "delivery_time": "3-5 business days",
  "icon": {},
  "localization": "16,18,20",
  "max_weight": 25.00,
  "min_weight": 0.10,
  "position": 10,
  "rate_calculation": "M",
  "rates": {
    "rate_value": {
      "C": {
        "0": {
          "range_from": "0.00",
          "range_to": "10.00",
          "value": "5.99"
        },
        "1": {
          "range_from": "10.01",
          "range_to": "50.00",
          "value": "8.99"
        },
        "2": {
          "range_from": "50.01",
          "range_to": "",
          "value": "0.00"
        }
      },
      "I": {},
      "W": {}
    }
  },
  "service_id": 0,
  "service_params": {},
  "shipping_id": 1,
  "status": "A",
  "tax_ids": "6",
  "usergroup_ids": "0"
}