Criar cluster de clientes
curl --request POST \
--url https://api.dooki.com.br/v2/{alias}/customers/clusters \
--header 'Content-Type: application/json' \
--header 'User-Secret-Key: <api-key>' \
--header 'User-Token: <api-key>' \
--data '
{
"name": "<string>",
"person_type": "<string>",
"min_order_value": "<string>",
"base_price_percent": "<string>",
"shipping_rules": [
{
"country": "<string>",
"zipcode_min": 123,
"zipcode_max": 123,
"min_order_value": "<string>",
"shipment_discount_percent": "<string>"
}
],
"active": true,
"attach_on_signup": true,
"payments_ids": [
123
],
"carriers_ids": [
123
]
}
'import requests
url = "https://api.dooki.com.br/v2/{alias}/customers/clusters"
payload = {
"name": "<string>",
"person_type": "<string>",
"min_order_value": "<string>",
"base_price_percent": "<string>",
"shipping_rules": [
{
"country": "<string>",
"zipcode_min": 123,
"zipcode_max": 123,
"min_order_value": "<string>",
"shipment_discount_percent": "<string>"
}
],
"active": True,
"attach_on_signup": True,
"payments_ids": [123],
"carriers_ids": [123]
}
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({
name: '<string>',
person_type: '<string>',
min_order_value: '<string>',
base_price_percent: '<string>',
shipping_rules: [
{
country: '<string>',
zipcode_min: 123,
zipcode_max: 123,
min_order_value: '<string>',
shipment_discount_percent: '<string>'
}
],
active: true,
attach_on_signup: true,
payments_ids: [123],
carriers_ids: [123]
})
};
fetch('https://api.dooki.com.br/v2/{alias}/customers/clusters', 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}/customers/clusters",
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([
'name' => '<string>',
'person_type' => '<string>',
'min_order_value' => '<string>',
'base_price_percent' => '<string>',
'shipping_rules' => [
[
'country' => '<string>',
'zipcode_min' => 123,
'zipcode_max' => 123,
'min_order_value' => '<string>',
'shipment_discount_percent' => '<string>'
]
],
'active' => true,
'attach_on_signup' => true,
'payments_ids' => [
123
],
'carriers_ids' => [
123
]
]),
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}/customers/clusters"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"person_type\": \"<string>\",\n \"min_order_value\": \"<string>\",\n \"base_price_percent\": \"<string>\",\n \"shipping_rules\": [\n {\n \"country\": \"<string>\",\n \"zipcode_min\": 123,\n \"zipcode_max\": 123,\n \"min_order_value\": \"<string>\",\n \"shipment_discount_percent\": \"<string>\"\n }\n ],\n \"active\": true,\n \"attach_on_signup\": true,\n \"payments_ids\": [\n 123\n ],\n \"carriers_ids\": [\n 123\n ]\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}/customers/clusters")
.header("User-Token", "<api-key>")
.header("User-Secret-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"person_type\": \"<string>\",\n \"min_order_value\": \"<string>\",\n \"base_price_percent\": \"<string>\",\n \"shipping_rules\": [\n {\n \"country\": \"<string>\",\n \"zipcode_min\": 123,\n \"zipcode_max\": 123,\n \"min_order_value\": \"<string>\",\n \"shipment_discount_percent\": \"<string>\"\n }\n ],\n \"active\": true,\n \"attach_on_signup\": true,\n \"payments_ids\": [\n 123\n ],\n \"carriers_ids\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dooki.com.br/v2/{alias}/customers/clusters")
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 \"name\": \"<string>\",\n \"person_type\": \"<string>\",\n \"min_order_value\": \"<string>\",\n \"base_price_percent\": \"<string>\",\n \"shipping_rules\": [\n {\n \"country\": \"<string>\",\n \"zipcode_min\": 123,\n \"zipcode_max\": 123,\n \"min_order_value\": \"<string>\",\n \"shipment_discount_percent\": \"<string>\"\n }\n ],\n \"active\": true,\n \"attach_on_signup\": true,\n \"payments_ids\": [\n 123\n ],\n \"carriers_ids\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"active": true,
"attach_on_signup": true,
"person_type": "<string>",
"min_order_value": 123,
"base_price_percent": 123,
"payments_ids": [
123
],
"carriers_ids": [
123
],
"restrictions": {
"include": {
"products_ids": [
123
],
"brands_ids": [
123
],
"collections_ids": [
123
],
"categories_ids": [
123
]
}
},
"exclude": {
"products_ids": [
123
],
"brands_ids": [
123
],
"collections_ids": [
123
],
"categories_ids": [
123
]
},
"include_ids": "[987, 654, 456, 321, 123]",
"exclude_ids": "[123, 321]",
"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"
}
}Clusters
Criar cluster de clientes
Cria um novo cluster de clientes
POST
/
{alias}
/
customers
/
clusters
Criar cluster de clientes
curl --request POST \
--url https://api.dooki.com.br/v2/{alias}/customers/clusters \
--header 'Content-Type: application/json' \
--header 'User-Secret-Key: <api-key>' \
--header 'User-Token: <api-key>' \
--data '
{
"name": "<string>",
"person_type": "<string>",
"min_order_value": "<string>",
"base_price_percent": "<string>",
"shipping_rules": [
{
"country": "<string>",
"zipcode_min": 123,
"zipcode_max": 123,
"min_order_value": "<string>",
"shipment_discount_percent": "<string>"
}
],
"active": true,
"attach_on_signup": true,
"payments_ids": [
123
],
"carriers_ids": [
123
]
}
'import requests
url = "https://api.dooki.com.br/v2/{alias}/customers/clusters"
payload = {
"name": "<string>",
"person_type": "<string>",
"min_order_value": "<string>",
"base_price_percent": "<string>",
"shipping_rules": [
{
"country": "<string>",
"zipcode_min": 123,
"zipcode_max": 123,
"min_order_value": "<string>",
"shipment_discount_percent": "<string>"
}
],
"active": True,
"attach_on_signup": True,
"payments_ids": [123],
"carriers_ids": [123]
}
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({
name: '<string>',
person_type: '<string>',
min_order_value: '<string>',
base_price_percent: '<string>',
shipping_rules: [
{
country: '<string>',
zipcode_min: 123,
zipcode_max: 123,
min_order_value: '<string>',
shipment_discount_percent: '<string>'
}
],
active: true,
attach_on_signup: true,
payments_ids: [123],
carriers_ids: [123]
})
};
fetch('https://api.dooki.com.br/v2/{alias}/customers/clusters', 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}/customers/clusters",
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([
'name' => '<string>',
'person_type' => '<string>',
'min_order_value' => '<string>',
'base_price_percent' => '<string>',
'shipping_rules' => [
[
'country' => '<string>',
'zipcode_min' => 123,
'zipcode_max' => 123,
'min_order_value' => '<string>',
'shipment_discount_percent' => '<string>'
]
],
'active' => true,
'attach_on_signup' => true,
'payments_ids' => [
123
],
'carriers_ids' => [
123
]
]),
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}/customers/clusters"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"person_type\": \"<string>\",\n \"min_order_value\": \"<string>\",\n \"base_price_percent\": \"<string>\",\n \"shipping_rules\": [\n {\n \"country\": \"<string>\",\n \"zipcode_min\": 123,\n \"zipcode_max\": 123,\n \"min_order_value\": \"<string>\",\n \"shipment_discount_percent\": \"<string>\"\n }\n ],\n \"active\": true,\n \"attach_on_signup\": true,\n \"payments_ids\": [\n 123\n ],\n \"carriers_ids\": [\n 123\n ]\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}/customers/clusters")
.header("User-Token", "<api-key>")
.header("User-Secret-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"person_type\": \"<string>\",\n \"min_order_value\": \"<string>\",\n \"base_price_percent\": \"<string>\",\n \"shipping_rules\": [\n {\n \"country\": \"<string>\",\n \"zipcode_min\": 123,\n \"zipcode_max\": 123,\n \"min_order_value\": \"<string>\",\n \"shipment_discount_percent\": \"<string>\"\n }\n ],\n \"active\": true,\n \"attach_on_signup\": true,\n \"payments_ids\": [\n 123\n ],\n \"carriers_ids\": [\n 123\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dooki.com.br/v2/{alias}/customers/clusters")
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 \"name\": \"<string>\",\n \"person_type\": \"<string>\",\n \"min_order_value\": \"<string>\",\n \"base_price_percent\": \"<string>\",\n \"shipping_rules\": [\n {\n \"country\": \"<string>\",\n \"zipcode_min\": 123,\n \"zipcode_max\": 123,\n \"min_order_value\": \"<string>\",\n \"shipment_discount_percent\": \"<string>\"\n }\n ],\n \"active\": true,\n \"attach_on_signup\": true,\n \"payments_ids\": [\n 123\n ],\n \"carriers_ids\": [\n 123\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"active": true,
"attach_on_signup": true,
"person_type": "<string>",
"min_order_value": 123,
"base_price_percent": 123,
"payments_ids": [
123
],
"carriers_ids": [
123
],
"restrictions": {
"include": {
"products_ids": [
123
],
"brands_ids": [
123
],
"collections_ids": [
123
],
"categories_ids": [
123
]
}
},
"exclude": {
"products_ids": [
123
],
"brands_ids": [
123
],
"collections_ids": [
123
],
"categories_ids": [
123
]
},
"include_ids": "[987, 654, 456, 321, 123]",
"exclude_ids": "[123, 321]",
"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"
}
}Path Parameters
Alias da loja
Body
application/json
Representa os dados necessários para criar ou atualizar um cluster de clientes
Nome do cluster
Tipo de pessoa
Valor mínimo do pedido
Percentual do preço base
Show child attributes
Show child attributes
Status do cluster
Anexar ao cadastro
IDs dos métodos de pagamento
IDs das transportadoras
Response
Cluster criado com sucesso
Clusters são grupos de clientes com condições comerciais flexíveis, como preço de produto, frete e forma de entrega
Identificador único do cluster.
Nome do cluster.
Indica se o cluster está ativo.
Indica se novos clientes são vinculados automaticamente a este cluster ao se cadastrarem.
Tipo de pessoa a que o cluster se aplica: f para pessoa física, j para pessoa jurídica.
Valor mínimo de pedido para que as condições comerciais do cluster sejam aplicadas, em reais.
Percentual aplicado sobre o preço base dos produtos para os clientes deste cluster.
IDs dos métodos de pagamento
IDs das transportadoras
Restrições de produtos às quais as condições do cluster se aplicam.
Show child attributes
Show child attributes
Produtos, marcas, coleções e categorias excluídos das condições do cluster.
Show child attributes
Show child attributes
Lista de IDs para inclusão
Example:
"[987, 654, 456, 321, 123]"
Lista de IDs para exclusão
Example:
"[123, 321]"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I