Tray

Clientes

GET
/v1/tray/customers

Retorna métricas de comércio, engajamento e ciclo de vida dos clientes Tray

Autorização

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Parâmetros de query

organizationId*string

Identificador da organização (obrigatório)

integrationId?string

Identificador da integração Tray

integrationName?string

Nome da integração Tray

page?integer

Número da página (padrão 1)

Padrão1
limit?integer

Itens por página (padrão 500, máx. 5000)

Intervalovalue <= 5000
Padrão500
id?string

Filtrar por ID do cliente

registrationDateStart?string

Filtrar por data de cadastro inicial

Formatodate-time
registrationDateEnd?string

Filtrar por data de cadastro final

Formatodate-time
createdStart?string

Filtrar por data de criação inicial

Formatodate-time
createdEnd?string

Filtrar por data de criação final

Formatodate-time
lastModifiedStart?string

Filtrar por última modificação inicial

Formatodate-time
lastModifiedEnd?string

Filtrar por última modificação final

Formatodate-time

Corpo da resposta

Resposta de clientes Tray

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/tray/customers?organizationId=org_123"
{  "data": [    {      "newsletter": "string",      "created": "2019-08-24T14:15:22Z",      "terms": "2019-08-24T14:15:22Z",      "id": "string",      "registration_date": "2019-08-24T14:15:22Z",      "email": "user@example.com",      "total_orders": 0,      "type": "string",      "is_foreign": "string",      "reseller": true,      "discount": 0.1,      "blocked": "string",      "credit_limit": 0.1,      "indicator_id": "string",      "profile_customer_id": "string",      "last_sending_newsletter": "2019-08-24T14:15:22Z",      "last_purchase": "2019-08-24T14:15:22Z",      "last_visit": "2019-08-24T14:15:22Z",      "last_modification": "2019-08-24T14:15:22Z",      "modified": "2019-08-24T14:15:22Z",      "count_orders": 0,      "integration_id": "string",      "organization_id": "string",      "document_id": "string",      "integration_name": "string",      "inserted_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}