YAyampi
Logística - Transportadoras

Criar transportadora

Cria uma nova transportadora com base nos parâmetros fornecidos

post/{alias}/logistics/carriers

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/logistics/carriers
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

Request body

activeboolean required

Indica se a transportadora está ativa e disponível para as cotações de frete.

namestring required

Nome da transportadora, único na loja, com até 100 caracteres.

only_backup_useboolean required

Indica se a transportadora deve ser usada apenas como backup, quando as demais não retornam cotação.

origin_zipcodestring required

CEP de origem usado no cálculo do frete desta transportadora.

increment_percentnumber float required

Percentual de acréscimo aplicado sobre o preço do frete da transportadora.

max_weightnumber float required

Peso máximo, em kg, aceito pela transportadora.

active_cubic_weightboolean required

Ativa a cubagem, considerando o peso cúbico dos itens no cálculo do frete.

cubic_weight_factornumber float required

Fator de cubagem usado para converter o volume dos itens em peso cúbico. Obrigatório quando active_cubic_weight é true.

min_cubic_weightnumber float required

Peso cúbico mínimo, em kg, considerado no cálculo do frete. Obrigatório quando active_cubic_weight é true.

weight_paramstring required

Tipo de peso usado no cálculo do frete: real para o peso dos produtos ou cubic para o peso cúbico. Obrigatório quando active_cubic_weight é true.

weight_conditionstring required

Operador de comparação entre o peso real e o peso cúbico (> ou <) que define quando o weight_param é aplicado. Obrigatório quando active_cubic_weight é true.

Response

Transportadora criada com sucesso

idinteger

ID da transportadora.

typestring

Tipo de cadastro dos preços da transportadora: simple para preço único ou spreadsheet para faixas de preço importadas por planilha. Assume simple quando não informado.

fixed_priceinteger

Preço único de frete, em reais, retornado quando a transportadora tem apenas uma faixa de preço cadastrada; nos demais casos vem 0.

fixed_shipping_timeinteger

Prazo de entrega, em dias, da faixa única de preço da transportadora; nos demais casos vem 0.

activeboolean

Indica se a transportadora está ativa e disponível para as cotações de frete.

namestring

Nome da transportadora, único na loja.

only_backup_useboolean

Indica se a transportadora deve ser usada apenas como backup, quando as demais não retornam cotação.

origin_zipcodestring

CEP de origem usado no cálculo do frete desta transportadora.

increment_percentnumber float

Percentual de acréscimo aplicado sobre o preço do frete da transportadora.

max_weightnumber float

Peso máximo, em kg, aceito pela transportadora.

active_cubic_weightboolean

Indica se a cubagem está ativa, considerando o peso cúbico dos itens no cálculo do frete.

cubic_weight_factornumber float

Fator de cubagem usado para converter o volume dos itens em peso cúbico.

min_cubic_weightnumber float

Peso cúbico mínimo, em kg, considerado no cálculo do frete.

weight_paramstring

Tipo de peso usado no cálculo do frete: real para o peso dos produtos ou cubic para o peso cúbico.

weight_conditionstring

Operador de comparação entre o peso real e o peso cúbico (> ou <) que define quando o weight_param é aplicado.

has_pricesinteger

Indica se a transportadora tem faixas de preço cadastradas.

total_pricesinteger

Total de faixas de preço cadastradas na transportadora.

Example response

{
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.