Nuvem Shop Customers
GET
https://rest.api.mktlab.app/v1/nuvem-shop/customers
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID único do cliente na plataforma NuvemShop. |
name | string | Nome completo do cliente. |
email | string | Endereço de e-mail do cliente. |
phone | string | Número de telefone do cliente. |
address | string | Endereço do cliente. |
city | string | Cidade do cliente. |
province | string | Estado ou província do cliente. |
zipcode | string | Código postal do cliente. |
total_spent | number | Valor total gasto pelo cliente. |
total_spent_currency | string | Moeda utilizada nos gastos do cliente (ex: BRL, USD). |
last_order_id | string | ID do último pedido realizado pelo cliente. |
active | boolean | Indica se o cliente está ativo. |
first_interaction | Date | Data e hora da primeira interação com o cliente (formato ISO 8601). |
created_at | Date | Data e hora em que o cliente foi criado na plataforma (formato ISO 8601). |
updated_at | Date | Data e hora da última atualização dos dados do cliente (formato ISO 8601). |
accepts_marketing | boolean | Indica se o cliente aceitou receber comunicações de marketing. |
accepts_marketing_updated_at | Date | Data e hora da última atualização do consentimento de marketing (formato ISO 8601). |
integration_id | string | ID da integração da plataforma com a conta do sistema NuvemShop. |
project_id | string | ID do projeto associado ao cliente. |
unit_id | string | ID da unidade de negócios associada ao cliente. |
document_id | string | ID do documento relacionado ao cliente. |
inserted_at | Date | Data e hora em que o registro foi inserido no sistema (formato ISO 8601). |
Requisição
Parâmetros de Consulta
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://rest.api.mktlab.app/v1/nuvem-shop/customers' \
--header 'Authorization: Bearer <token>'Response Response Example
{
"data": [
{
"id": "152398079",
"name": "Igor Lima",
"email": null,
"phone": null,
"address": null,
"city": null,
"province": null,
"zipcode": null,
"total_spent": null,
"total_spent_currency": null,
"last_order_id": null,
"active": null,
"first_interaction": null,
"created_at": "2024-02-27T19:27:21.000Z",
"updated_at": "2025-04-16T21:00:39.000Z",
"accepts_marketing": null,
"accepts_marketing_updated_at": null,
"integration_id": "4331287",
"project_id": "659d8d2377f690b44d4bc6f4",
"unit_id": "664285ad2af8b0593ab30f6e",
"document_id": "68013e6b4d896335058b17d2",
"inserted_at": "2025-04-23T13:01:26.000Z"
},
{
"id": "151878874",
"name": "Igor Lima",
"email": null,
"phone": null,
"address": null,
"city": null,
"province": null,
"zipcode": null,
"total_spent": null,
"total_spent_currency": null,
"last_order_id": null,
"active": null,
"first_interaction": null,
"created_at": "2024-02-22T15:15:34.000Z",
"updated_at": "2024-02-26T20:28:07.000Z",
"accepts_marketing": null,
"accepts_marketing_updated_at": null,
"integration_id": "4331287",
"project_id": "659d8d2377f690b44d4bc6f4",
"unit_id": "664285ad2af8b0593ab30f6e",
"document_id": "68013e6b4d896335058b17d2",
"inserted_at": "2025-04-23T13:01:26.000Z"
},
{
"id": "152381525",
"name": "Eduardo Coudet",
"email": null,
"phone": null,
"address": null,
"city": null,
"province": null,
"zipcode": null,
"total_spent": null,
"total_spent_currency": null,
"last_order_id": null,
"active": null,
"first_interaction": null,
"created_at": "2024-02-27T17:36:32.000Z",
"updated_at": "2024-02-27T21:57:50.000Z",
"accepts_marketing": null,
"accepts_marketing_updated_at": null,
"integration_id": "4331287",
"project_id": "659d8d2377f690b44d4bc6f4",
"unit_id": "664285ad2af8b0593ab30f6e",
"document_id": "68013e6b4d896335058b17d2",
"inserted_at": "2025-04-23T13:01:26.000Z"
}
],
"meta": {
"page": 1,
"limit": 500,
"total": 3,
"totalPages": 1,
"hasNextPage": false,
"hasPreviousPage": false
}
}Modificado em 2025-10-08 17:25:55