---
title: "Criar cluster de clientes"
method: POST
path: "/{alias}/customers/clusters"
tags: ["Clientes - Clusters"]
---

# Criar cluster de clientes

`POST /{alias}/customers/clusters`

Cria um novo cluster de clientes

## Path parameters

- `alias` string, required

## Request body

- ClusterRequest — Representa os dados necessários para criar ou atualizar um cluster de clientes
  - `name` string, required — Nome do cluster
  - `active` boolean — Status do cluster
  - `person_type` string, required — Tipo de pessoa
  - `attach_on_signup` boolean — Anexar ao cadastro
  - `min_order_value` string, required — Valor mínimo do pedido
  - `base_price_percent` string, required — Percentual do preço base
  - `payments_ids` integer[] — IDs dos métodos de pagamento
  - `carriers_ids` integer[] — IDs das transportadoras
  - `shipping_rules` object[], required
    - `country` string, required — País
    - `zipcode_min` integer, required — CEP mínimo
    - `zipcode_max` integer, required — CEP máximo
    - `min_order_value` string, required — Valor mínimo do pedido
    - `shipment_discount_percent` string, required — Percentual de desconto no frete

## Response `200`

Cluster criado com sucesso

- Cluster — 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, float
  - `base_price_percent` integer
  - `payments_ids` integer[] — IDs dos métodos de pagamento
  - `carriers_ids` integer[] — IDs das transportadoras
  - `restrictions` object
    - `include` object
      - `products_ids` integer[]
      - `brands_ids` integer[]
      - `collections_ids` integer[]
      - `categories_ids` integer[]
  - `exclude` object
    - `products_ids` integer[]
    - `brands_ids` integer[]
    - `collections_ids` integer[]
    - `categories_ids` integer[]
  - `include_ids` integer[] — Lista de IDs para inclusão
  - `exclude_ids` integer[] — Lista de IDs para exclusão
  - `created_at` BaseTimestamp
    - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
    - `timezone_type` integer — Número de representação do timezone.
    - `timezone` string — Fuso horário associado.
  - `updated_at` BaseTimestamp
    - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS.
    - `timezone_type` integer — Número de representação do timezone.
    - `timezone` string — Fuso horário associado.

## Other responses

- `400` — Requisição inválida

---

[API](https://skmtc.net/yampi/apis/yampi-api.md) · [All operations](https://skmtc.net/yampi/apis/yampi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yampi/yampi-api/revisions/fa16c50bef09/schema)