v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB

Clientes - Cliente

Listar clientes

Lista todos os clientes

get/{alias}/customers

Path parameters

aliasstring required

Alias da loja

Query parameters

includestring[]

Incluir relacionamentos adicionais

[
  "?include=addresses,stats"
]

state_ufstring[]

Estado (UF) associado ao registro.

activeinteger

Status do registro (ativa=1 ou inativa=0).

clusters_idsinteger[]

IDs dos clusters associados aos clientes.

buy_product_idinteger[]

IDs dos produtos comprados pelos clientes.

total_ordersinteger

Número total de pedidos feitos pelo cliente.

bought_atstring

Filtro por data de compra.

Filtros por campanha, origem, datas e status

{
  "bought_at": "?bought_at=bought_at:2025-05-01|2025-05-31"
}

Response

Lista de clientes retornada com sucesso

Example response

{
  "data": [
    {
      "spreadsheet": {
        "data": {
          "phone": "(16) 98187-5668",
          "phone_number": "981875668",
          "phone_code": "16"
        }
      }
    }
  ]
}