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>",
  "active": true,
  "person_type": "<string>",
  "attach_on_signup": true,
  "min_order_value": "<string>",
  "base_price_percent": "<string>",
  "payments_ids": [
    123
  ],
  "carriers_ids": [
    123
  ],
  "shipping_rules": [
    {
      "country": "<string>",
      "zipcode_min": 123,
      "zipcode_max": 123,
      "min_order_value": "<string>",
      "shipment_discount_percent": "<string>"
    }
  ]
}'
{
  "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"
  }
}

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 um cluster de clientes

name
string
required

Nome do cluster

person_type
string
required

Tipo de pessoa

min_order_value
string
required

Valor mínimo do pedido

base_price_percent
string
required

Percentual do preço base

shipping_rules
object[]
required
active
boolean

Status do cluster

attach_on_signup
boolean

Anexar ao cadastro

payments_ids
integer[]

IDs dos métodos de pagamento

carriers_ids
integer[]

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

id
integer
name
string
active
boolean
attach_on_signup
boolean
person_type
string
min_order_value
number
base_price_percent
integer
payments_ids
integer[]

IDs dos métodos de pagamento

carriers_ids
integer[]

IDs das transportadoras

restrictions
object
exclude
object
include_ids
integer[]

Lista de IDs para inclusão

Example:

"[987, 654, 456, 321, 123]"

exclude_ids
integer[]

Lista de IDs para exclusão

Example:

"[123, 321]"

created_at
object
updated_at
object