Skip to main content
GET
Visualizar clusters

Authorizations

User-Token
string
header
required
User-Secret-Key
string
header
required

Path Parameters

alias
string
required

Alias da loja

id
integer
required

ID do cluster

Response

Detalhes visualizados 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

Identificador único do cluster.

name
string

Nome do cluster.

active
boolean

Indica se o cluster está ativo.

attach_on_signup
boolean

Indica se novos clientes são vinculados automaticamente a este cluster ao se cadastrarem.

person_type
string

Tipo de pessoa a que o cluster se aplica: f para pessoa física, j para pessoa jurídica.

min_order_value
number<float>

Valor mínimo de pedido para que as condições comerciais do cluster sejam aplicadas, em reais.

base_price_percent
integer

Percentual aplicado sobre o preço base dos produtos para os clientes deste cluster.

payments_ids
integer[]

IDs dos métodos de pagamento

carriers_ids
integer[]

IDs das transportadoras

restrictions
object

Restrições de produtos às quais as condições do cluster se aplicam.

exclude
object

Produtos, marcas, coleções e categorias excluídos das condições do cluster.

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