CData Python Connector for Shopify

Build 25.0.9454

Customers

Lists customers with core profile data, marketing preferences, and tags.

Table-Specific Information

Select

The connector uses the Shopify API to process WHERE clause conditions built with the following columns and operators. The connector processes other filters client-side within the connector.

  • Id supports the '=, IN' comparison operators.
  • Email supports the '=, !=' comparison operators.
  • Phone supports the '=, !=' comparison operators.
  • CreatedAt supports the '=, !=, <, >, >=, <=' comparison operators.
  • UpdatedAt supports the '=, !=, <, >, >=, <=' comparison operators.

For example, the following queries are processed server-side:

  SELECT * FROM Customers WHERE Id = 'Val1'
  SELECT * FROM Customers WHERE Email = 'Val1'
  SELECT * FROM Customers WHERE Phone = 'Val1'
  SELECT * FROM Customers WHERE CreatedAt = '2023-01-01 11:10:00'
  SELECT * FROM Customers WHERE UpdatedAt = '2023-01-01 11:10:00'

Insert

The following columns can be used to create a new record:

FirstName, LastName, Email, Locale, Note, Phone, Tags, TaxExempt, TaxExemptions, DefaultAddressFirstName, DefaultAddressLastName, DefaultAddressAddress1, DefaultAddressAddress2, DefaultAddressCity, DefaultAddressCompany, DefaultAddressCountry, DefaultAddressPhone, DefaultAddressProvince, DefaultAddressZip, DefaultAddressProvinceCode, DefaultAddressCountryCodeV2, EmailMarketingConsentMarketingState, EmailMarketingConsentMarketingOptInLevel, EmailMarketingConsentConsentUpdatedAt, EmailMarketingConsentSourceLocationId, SmsMarketingConsentMarketingState, SmsMarketingConsentMarketingOptInLevel, SmsMarketingConsentConsentUpdatedAt, SmsMarketingConsentSourceLocationId

Update

The following columns can be updated:

FirstName, LastName, Email, Locale, Note, Phone, Tags, TaxExempt, TaxExemptions, DefaultAddressFirstName, DefaultAddressLastName, DefaultAddressAddress1, DefaultAddressAddress2, DefaultAddressCity, DefaultAddressCompany, DefaultAddressCountry, DefaultAddressPhone, DefaultAddressProvince, DefaultAddressZip, DefaultAddressProvinceCode, DefaultAddressCountryCodeV2, EmailMarketingConsentMarketingState, EmailMarketingConsentMarketingOptInLevel, EmailMarketingConsentConsentUpdatedAt, EmailMarketingConsentSourceLocationId, SmsMarketingConsentMarketingState, SmsMarketingConsentMarketingOptInLevel, SmsMarketingConsentConsentUpdatedAt, SmsMarketingConsentSourceLocationId

Delete

You can delete entries by specifying the following column:

Id

Columns

Name Type ReadOnly References Description
Id [KEY] String True

The globally unique identifier of the customer.

MultipassIdentifier String True

A unique identifier for the customer used with Multipass login.

LegacyResourceId String True

The legacy identifier of the customer in the REST Admin API.

ValidEmailAddress Bool True

Indicates whether the customer's email address is correctly formatted and belongs to an existing domain. This does not guarantee the email address actually exists.

DisplayName String True

The display name of the customer, derived from first and last name. Falls back to the customer's email, or if unavailable, their phone number.

FirstName String False

The first name of the customer.

LastName String False

The last name of the customer.

Email String False

The email address of the customer.

Locale String False

The preferred locale (language) of the customer.

Note String False

A merchant-facing note about the customer.

Phone String False

The phone number of the customer.

State String True

The current state of the customer's account with the shop.

Tags String False

A comma-separated list of tags assigned to the customer.

CanDelete Bool True

Indicates whether the customer can be deleted from the store. Customers cannot be deleted if they have placed at least one order.

LifetimeDuration String True

The length of time since the customer was first added to the store, expressed in a readable format such as 'about 12 years'.

TaxExempt Bool False

Indicates whether the customer is exempt from being charged taxes on their orders.

TaxExemptions String False

A list of tax exemptions applied to the customer.

UnsubscribeUrl String True

The URL where the customer can unsubscribe from the store's mailing list.

VerifiedEmail Bool True

Indicates whether the customer has verified their email address. Defaults to true if the customer is created through the Shopify Admin or API.

NumberOfOrders String True

The total number of orders the customer has placed with the store.

ProductSubscriberStatus String True

The current subscription status of the customer, defined by their subscription contracts.

CreatedAt Datetime True

The date and time when the customer was created in the store.

UpdatedAt Datetime True

The date and time when the customer record was last updated.

AmountSpentAmount Decimal True

The total amount the customer has spent, expressed as a decimal money value.

AmountSpentCurrencyCode String True

The currency code for the customer's total spent amount.

DefaultAddressId String True

The globally unique identifier of the customer's default address.

DefaultAddressCoordinatesValidated Bool True

Indicates whether the default address coordinates are valid.

DefaultAddressValidationResultSummary String True

The validation status of the default address, as determined by the Shopify Admin address validation feature.

DefaultAddressName String True

The full name of the customer on the default address, based on first and last name.

DefaultAddressFirstName String False

The first name on the customer's default address.

DefaultAddressLastName String False

The last name on the customer's default address.

DefaultAddressAddress1 String False

The first line of the customer's default address, typically a street address or PO Box.

DefaultAddressAddress2 String False

The second line of the customer's default address, typically an apartment, suite, or unit number.

DefaultAddressCity String False

The city, town, district, or village of the customer's default address.

DefaultAddressCompany String False

The company or organization name listed on the customer's default address.

DefaultAddressCountry String False

The country of the customer's default address.

DefaultAddressLatitude Double True

The latitude coordinate of the customer's default address.

DefaultAddressLongitude Double True

The longitude coordinate of the customer's default address.

DefaultAddressPhone String False

The phone number associated with the default address, formatted using the E.164 standard (for example, +16135551111).

DefaultAddressProvince String False

The province, state, or district of the customer's default address.

DefaultAddressZip String False

The postal or ZIP code of the customer's default address.

DefaultAddressFormattedArea String True

A comma-separated string combining the city, province, and country of the default address.

DefaultAddressProvinceCode String False

The two-letter code for the province, state, or district of the default address, such as 'ON', for Ontario.

DefaultAddressCountryCodeV2 String False

The two-letter country code of the customer's default address, such as US.

EmailMarketingConsentMarketingState String False

The current email marketing consent state of the customer.

EmailMarketingConsentMarketingOptInLevel String False

The email marketing opt-in level set by the customer when consenting, based on M3AAWG best practice guidelines.

EmailMarketingConsentConsentUpdatedAt Datetime False

The date and time when the customer last updated their email marketing consent. If not provided, defaults to when the consent information was originally sent.

EmailMarketingConsentSourceLocationId String False

The identifier of the location where the customer provided email marketing consent.

ImageId String True

The globally unique identifier of the customer's image.

ImageWidth Int True

The original width of the customer image in pixels. Returns null if the image is not hosted by Shopify.

ImageAltText String True

Alternative text describing the content or purpose of the customer image.

ImageHeight Int True

The original height of the customer image in pixels. Returns null if the image is not hosted by Shopify.

ImageUrl String True

The URL of the customer image.

LastOrderId String True

The globally unique identifier of the customer's most recent order.

MarketId String True

The globally unique identifier of the market associated with the customer.

MergeableReason String True

The reason why the customer cannot be merged with another customer.

MergeableErrorFields String True

A list of fields preventing the customer from being merged.

MergeableIsMergeable Bool True

Indicates whether the customer can be merged with another customer.

MergeableMergeInProgressJobId String True

The identifier of the merge job in progress.

MergeableMergeInProgressResultingCustomerId String True

The identifier of the resulting customer after the merge.

MergeableMergeInProgressStatus String True

The current status of the customer merge request.

SmsMarketingConsentMarketingState String False

The current SMS marketing consent state of the customer.

SmsMarketingConsentConsentCollectedFrom String True

The source from which the customer's SMS marketing consent was collected.

SmsMarketingConsentMarketingOptInLevel String False

The SMS marketing opt-in level set by the customer when consenting to receive SMS communications.

SmsMarketingConsentConsentUpdatedAt Datetime False

The date and time when the customer last updated their SMS marketing consent. If not provided, defaults to when the consent information was originally sent.

SmsMarketingConsentSourceLocationId String False

The identifier of the location where the customer provided SMS marketing consent.

StatisticsPredictedSpendTier String True

The predicted spend tier of the customer in the shop.

StatisticsRFMGroup String True

The RFM (Recency, Frequency, Monetary) group classification of the customer.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454