Shopify

Customers

GET
/v1/shopify/customers

Retrieve Shopify customers with email marketing consent and aggregated order info

Authorization

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Query Parameters

organizationId*string

Organization identifier (required)

integrationId?string

Shopify integration identifier

integrationName?string

Shopify integration name

id?string

Filter by customer ID

page?integer

Page number (default 1)

Default1
limit?integer

Items per page (default 500, max 5000)

Rangevalue <= 5000
Default500
createdStart?string

Filter by creation date start (ISO 8601)

Formatdate-time
createdEnd?string

Filter by creation date end (ISO 8601)

Formatdate-time
lastModifiedStart?string

Filter by last update date start

Formatdate-time
lastModifiedEnd?string

Filter by last update date end

Formatdate-time

Response Body

Shopify customers response

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/shopify/customers?organizationId=org_123"
{  "data": [    {      "id": "string",      "email": "user@example.com",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "number_of_orders": 0,      "state": "string",      "verified_email": true,      "tax_exempt": true,      "email_marketing_consent_marketing_state": "string",      "email_marketing_consent_marketing_opt_in_level": "string",      "email_marketing_consent_consent_updated_at": "2019-08-24T14:15:22Z",      "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  }}