YAyampi
Clientes - Clusters

Visualizar clusters

Obtém os detalhes de um cluster específico

get/{alias}/customers/clusters/{id}

Request

  • Base URL
    https://api.dooki.com.br/v2
  • URL
    https://api.dooki.com.br/v2/{alias}/customers/clusters/{id}
  • Auth
    API key in header User-Token and API key in header User-Secret-Key

Path parameters

aliasstring required

Alias da loja

idinteger required

ID do cluster

Response

Detalhes visualizados com sucesso

idinteger

Identificador único do cluster.

namestring

Nome do cluster.

activeboolean

Indica se o cluster está ativo.

attach_on_signupboolean

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

person_typestring

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

min_order_valuenumber float

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

base_price_percentinteger

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

payments_idsinteger[]

IDs dos métodos de pagamento

carriers_idsinteger[]

IDs das transportadoras

include_idsinteger[]

Lista de IDs para inclusão

exclude_idsinteger[]

Lista de IDs para exclusão

Example response

{
  "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"
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.