Criar transportadora

curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/logistics/carriers \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "active": true,
  "name": "<string>",
  "only_backup_use": true,
  "origin_zipcode": "<string>",
  "increment_percent": 123,
  "max_weight": 123,
  "active_cubic_weight": true,
  "cubic_weight_factor": 123,
  "min_cubic_weight": 123,
  "weight_param": "<string>",
  "weight_condition": "<string>"
}
'

import requests

url = "https://api.dooki.com.br/v2/{alias}/logistics/carriers"

payload = {
    "active": True,
    "name": "<string>",
    "only_backup_use": True,
    "origin_zipcode": "<string>",
    "increment_percent": 123,
    "max_weight": 123,
    "active_cubic_weight": True,
    "cubic_weight_factor": 123,
    "min_cubic_weight": 123,
    "weight_param": "<string>",
    "weight_condition": "<string>"
}
headers = {
    "User-Token": "<api-key>",
    "User-Secret-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'User-Token': '<api-key>',
    'User-Secret-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    active: true,
    name: '<string>',
    only_backup_use: true,
    origin_zipcode: '<string>',
    increment_percent: 123,
    max_weight: 123,
    active_cubic_weight: true,
    cubic_weight_factor: 123,
    min_cubic_weight: 123,
    weight_param: '<string>',
    weight_condition: '<string>'
  })
};

fetch('https://api.dooki.com.br/v2/{alias}/logistics/carriers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dooki.com.br/v2/{alias}/logistics/carriers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => true,
    'name' => '<string>',
    'only_backup_use' => true,
    'origin_zipcode' => '<string>',
    'increment_percent' => 123,
    'max_weight' => 123,
    'active_cubic_weight' => true,
    'cubic_weight_factor' => 123,
    'min_cubic_weight' => 123,
    'weight_param' => '<string>',
    'weight_condition' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "User-Secret-Key: <api-key>",
    "User-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dooki.com.br/v2/{alias}/logistics/carriers"

	payload := strings.NewReader("{\n  \"active\": true,\n  \"name\": \"<string>\",\n  \"only_backup_use\": true,\n  \"origin_zipcode\": \"<string>\",\n  \"increment_percent\": 123,\n  \"max_weight\": 123,\n  \"active_cubic_weight\": true,\n  \"cubic_weight_factor\": 123,\n  \"min_cubic_weight\": 123,\n  \"weight_param\": \"<string>\",\n  \"weight_condition\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("User-Token", "<api-key>")
	req.Header.Add("User-Secret-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dooki.com.br/v2/{alias}/logistics/carriers")
  .header("User-Token", "<api-key>")
  .header("User-Secret-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": true,\n  \"name\": \"<string>\",\n  \"only_backup_use\": true,\n  \"origin_zipcode\": \"<string>\",\n  \"increment_percent\": 123,\n  \"max_weight\": 123,\n  \"active_cubic_weight\": true,\n  \"cubic_weight_factor\": 123,\n  \"min_cubic_weight\": 123,\n  \"weight_param\": \"<string>\",\n  \"weight_condition\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dooki.com.br/v2/{alias}/logistics/carriers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["User-Token"] = '<api-key>'
request["User-Secret-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"active\": true,\n  \"name\": \"<string>\",\n  \"only_backup_use\": true,\n  \"origin_zipcode\": \"<string>\",\n  \"increment_percent\": 123,\n  \"max_weight\": 123,\n  \"active_cubic_weight\": true,\n  \"cubic_weight_factor\": 123,\n  \"min_cubic_weight\": 123,\n  \"weight_param\": \"<string>\",\n  \"weight_condition\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "type": "<string>",
  "fixed_price": 123,
  "fixed_shipping_time": 123,
  "active": true,
  "name": "<string>",
  "only_backup_use": true,
  "origin_zipcode": "<string>",
  "increment_percent": 123,
  "max_weight": 123,
  "active_cubic_weight": true,
  "cubic_weight_factor": 123,
  "min_cubic_weight": 123,
  "weight_param": "<string>",
  "weight_condition": "<string>",
  "has_prices": 123,
  "total_prices": 123,
  "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"
  }
}

POST

{alias}

logistics

carriers

Criar transportadora

curl --request POST \
  --url https://api.dooki.com.br/v2/{alias}/logistics/carriers \
  --header 'Content-Type: application/json' \
  --header 'User-Secret-Key: <api-key>' \
  --header 'User-Token: <api-key>' \
  --data '
{
  "active": true,
  "name": "<string>",
  "only_backup_use": true,
  "origin_zipcode": "<string>",
  "increment_percent": 123,
  "max_weight": 123,
  "active_cubic_weight": true,
  "cubic_weight_factor": 123,
  "min_cubic_weight": 123,
  "weight_param": "<string>",
  "weight_condition": "<string>"
}
'

import requests

url = "https://api.dooki.com.br/v2/{alias}/logistics/carriers"

payload = {
    "active": True,
    "name": "<string>",
    "only_backup_use": True,
    "origin_zipcode": "<string>",
    "increment_percent": 123,
    "max_weight": 123,
    "active_cubic_weight": True,
    "cubic_weight_factor": 123,
    "min_cubic_weight": 123,
    "weight_param": "<string>",
    "weight_condition": "<string>"
}
headers = {
    "User-Token": "<api-key>",
    "User-Secret-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'User-Token': '<api-key>',
    'User-Secret-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    active: true,
    name: '<string>',
    only_backup_use: true,
    origin_zipcode: '<string>',
    increment_percent: 123,
    max_weight: 123,
    active_cubic_weight: true,
    cubic_weight_factor: 123,
    min_cubic_weight: 123,
    weight_param: '<string>',
    weight_condition: '<string>'
  })
};

fetch('https://api.dooki.com.br/v2/{alias}/logistics/carriers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dooki.com.br/v2/{alias}/logistics/carriers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'active' => true,
    'name' => '<string>',
    'only_backup_use' => true,
    'origin_zipcode' => '<string>',
    'increment_percent' => 123,
    'max_weight' => 123,
    'active_cubic_weight' => true,
    'cubic_weight_factor' => 123,
    'min_cubic_weight' => 123,
    'weight_param' => '<string>',
    'weight_condition' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "User-Secret-Key: <api-key>",
    "User-Token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dooki.com.br/v2/{alias}/logistics/carriers"

	payload := strings.NewReader("{\n  \"active\": true,\n  \"name\": \"<string>\",\n  \"only_backup_use\": true,\n  \"origin_zipcode\": \"<string>\",\n  \"increment_percent\": 123,\n  \"max_weight\": 123,\n  \"active_cubic_weight\": true,\n  \"cubic_weight_factor\": 123,\n  \"min_cubic_weight\": 123,\n  \"weight_param\": \"<string>\",\n  \"weight_condition\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("User-Token", "<api-key>")
	req.Header.Add("User-Secret-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dooki.com.br/v2/{alias}/logistics/carriers")
  .header("User-Token", "<api-key>")
  .header("User-Secret-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"active\": true,\n  \"name\": \"<string>\",\n  \"only_backup_use\": true,\n  \"origin_zipcode\": \"<string>\",\n  \"increment_percent\": 123,\n  \"max_weight\": 123,\n  \"active_cubic_weight\": true,\n  \"cubic_weight_factor\": 123,\n  \"min_cubic_weight\": 123,\n  \"weight_param\": \"<string>\",\n  \"weight_condition\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dooki.com.br/v2/{alias}/logistics/carriers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["User-Token"] = '<api-key>'
request["User-Secret-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"active\": true,\n  \"name\": \"<string>\",\n  \"only_backup_use\": true,\n  \"origin_zipcode\": \"<string>\",\n  \"increment_percent\": 123,\n  \"max_weight\": 123,\n  \"active_cubic_weight\": true,\n  \"cubic_weight_factor\": 123,\n  \"min_cubic_weight\": 123,\n  \"weight_param\": \"<string>\",\n  \"weight_condition\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "type": "<string>",
  "fixed_price": 123,
  "fixed_shipping_time": 123,
  "active": true,
  "name": "<string>",
  "only_backup_use": true,
  "origin_zipcode": "<string>",
  "increment_percent": 123,
  "max_weight": 123,
  "active_cubic_weight": true,
  "cubic_weight_factor": 123,
  "min_cubic_weight": 123,
  "weight_param": "<string>",
  "weight_condition": "<string>",
  "has_prices": 123,
  "total_prices": 123,
  "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"
  }
}

Authorizations

User-Token

string

header

required

User-Secret-Key

string

header

required

Path Parameters

alias

string

required

Alias da loja

Body

application/json

Representa os dados necessários para criar ou atualizar uma transportadora

active

boolean

required

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

name

string

required

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

only_backup_use

boolean

required

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

origin_zipcode

string

required

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

increment_percent

number<float>

required

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

max_weight

number<float>

required

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

active_cubic_weight

boolean

required

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

cubic_weight_factor

number<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_weight

number<float>

required

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

weight_param

string

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_condition

string

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

Transportadora cadastrada na loja, com as regras de cálculo e as faixas de preço usadas nas cotações de frete.

integer

ID da transportadora.

type

string

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_price

integer

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_time

integer

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

active

boolean

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

name

string

Nome da transportadora, único na loja.

only_backup_use

boolean

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

origin_zipcode

string

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

increment_percent

number<float>

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

max_weight

number<float>

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

active_cubic_weight

boolean

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

cubic_weight_factor

number<float>

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

min_cubic_weight

number<float>

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

weight_param

string

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

weight_condition

string

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

has_prices

integer

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

total_prices

integer

Total de faixas de preço cadastradas na transportadora.

created_at

object

Show child attributes

updated_at

object

Show child attributes