Customers

GET

https://api.data.v4.marketing/v1/shopify/customers

Retrieve Shopify customers with profile data, marketing consents, and aggregated order info

Requisição

Authorization

API Key

Adicionar parâmetro em header

x-client-id

Exemplo:

x-client-id: ********************

API Key

Adicionar parâmetro em header

x-client-secret

Exemplo:

x-client-secret: ********************

Parâmetros de Consulta

Respostas

🟢200OK

application/json

Shopify customers response

Body

🟠400Bad Request

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.data.v4.marketing/v1/shopify/customers?workspaceId=workspace_123&organizationId&integrationId&page&limit&orderBy&orderDirection&createdStart&createdEnd&lastModifiedStart&lastModifiedEnd&firstName&lastName&email&id&orderId&codeState&codeCountry' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'

Response Example

200 - Exemplo 1

{
    "data": [
        {
            "id": "string",
            "first_name": "string",
            "last_name": "string",
            "email": "user@example.com",
            "phone": "string",
            "created_at": "2019-08-24T14:15:22.123Z",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "number_of_orders": 0,
            "state": "string",
            "verified_email": true,
            "multipass_identifier": "string",
            "tax_exempt": true,
            "tags": "string",
            "default_address_id": "string",
            "default_address_first_name": "string",
            "default_address_last_name": "string",
            "default_address_company": "string",
            "default_address_address1": "string",
            "default_address_address2": "string",
            "default_address_city": "string",
            "default_address_province": "string",
            "default_address_country": "string",
            "default_address_zip": "string",
            "default_address_phone": "string",
            "default_address_name": "string",
            "default_address_province_code": "string",
            "default_address_country_code_v2": "string",
            "email_marketing_consent_marketing_state": "string",
            "email_marketing_consent_marketing_opt_in_level": "string",
            "email_marketing_consent_consent_updated_at": "2019-08-24T14:15:22.123Z",
            "sms_marketing_consent_marketing_state": "string",
            "sms_marketing_consent_marketing_opt_in_level": "string",
            "sms_marketing_consent_consent_updated_at": "2019-08-24T14:15:22.123Z",
            "integration_id": "string",
            "workspace_id": "string",
            "organization_id": "string",
            "document_id": "string",
            "inserted_at": "2019-08-24T14:15:22.123Z"
        }
    ],
    "meta": {
        "page": 0,
        "limit": 0,
        "hasNextPage": true,
        "hasPreviousPage": true
    }
}

Modificado em 2025-12-01 14:45:08