Endpoint

Get Customers

Name

get_customers

Description

Gets a list of customers. [API reference]

Related Tables

Customers

Parameters

Parameter

Label

Required

Options

Description

ids

Customer Id(s) - Comma separated

Restrict results to records specified by a comma-separated list of IDs. Max IDs per request controlled by BatchSize property (found in PaginationParams)

since_id

Since Customer Id

Restrict results to those created after the specified customer ID.

limit

Page Size

The maximum number of records to show.

fields

Only Fields to Show

Option	Value
id	id
email	email
accepts_marketing	accepts_marketing
created_at	created_at
updated_at	updated_at
first_name	first_name
last_name	last_name
orders_count	orders_count
state	state
total_spent	total_spent
last_order_id	last_order_id
note	note
verified_email	verified_email
multipass_identifier	multipass_identifier
tax_exempt	tax_exempt
tags	tags
last_order_name	last_order_name
currency	currency
phone	phone
accepts_marketing_updated_at	accepts_marketing_updated_at
marketing_opt_in_level	marketing_opt_in_level
sms_marketing_consent	sms_marketing_consent
admin_graphql_api_id	admin_graphql_api_id

Limit data retrieval to only the selected customer-related fields.

created_at_max

Created Before

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2014-04-25T16:15:47	2014-04-25T16:15:47
2014-04-25T16:15:47-04:00	2014-04-25T16:15:47-04:00

Restrict results to records created before a specified date. (format: 2014-04-25T16:15:47). Supported options are the following: now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)

created_at_min

Created After

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2014-04-25T16:15:47	2014-04-25T16:15:47
2014-04-25T16:15:47-04:00	2014-04-25T16:15:47-04:00

Restrict results to records created after a specified date. (format: 2014-04-25T16:15:47). Supported options are the following: now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)

updated_at_max

Updated Before

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2014-04-25T16:15:47	2014-04-25T16:15:47
2014-04-25T16:15:47-04:00	2014-04-25T16:15:47-04:00

Restrict results to records last updated before a specified date. (format: 2014-04-25T16:15:47). Supported options are the following: now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)

updated_at_min

Updated After

Option	Value
today	today
yesterday	yesterday
monthstart	monthstart
monthend	monthend
yearstart	yearstart
yearend	yearend
weekstart	weekstart
weekend	weekend
yearstart-1y	yearstart-1y
yearend-1y	yearend-1y
monthstart-1d	monthstart-1d
monthend+1d	monthend+1d
2014-04-25T16:15:47	2014-04-25T16:15:47
2014-04-25T16:15:47-04:00	2014-04-25T16:15:47-04:00

Restrict results to records last updated after a specified date. (format: 2014-04-25T16:15:47). Supported options are the following: now|today|yesterday|weekstart|weekend|monthstart|monthend|yearstart|yearend and supported intervals for add/subtract are ms|s|sec|min|h|hour|y|year|d|day|m|month|y|year. Example monthstart-3d (subtract 3 days from month start)

Output Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw
Id	`DT_I8`	`bigint`		`False`
Email	`DT_WSTR`	`nvarchar(255)`	255	`False`
AcceptsMarketing	`DT_BOOL`	`bit`		`False`
CreatedAt	`DT_DBTIMESTAMP`	`datetime`		`False`
UpdatedAt	`DT_DBTIMESTAMP`	`datetime`		`False`
FirstName	`DT_WSTR`	`nvarchar(255)`	255	`False`
LastName	`DT_WSTR`	`nvarchar(255)`	255	`False`
OrdersCount	`DT_I4`	`int`		`False`
State	`DT_WSTR`	`nvarchar(255)`	255	`False`
TotalSpent	`DT_WSTR`	`nvarchar(50)`	50	`False`
LastOrderId	`DT_I8`	`bigint`		`False`
Note	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
VerifiedEmail	`DT_BOOL`	`bit`		`False`
MultipassIdentifier	`DT_WSTR`	`nvarchar(255)`	255	`False`
TaxExempt	`DT_BOOL`	`bit`		`False`
TaxExemptions	`DT_WSTR`	`nvarchar(4000)`	4000	`True`
Tags	`DT_WSTR`	`nvarchar(4000)`	4000	`False`
LastOrderName	`DT_WSTR`	`nvarchar(255)`	255	`False`
Currency	`DT_WSTR`	`nvarchar(20)`	20	`False`
Phone	`DT_WSTR`	`nvarchar(30)`	30	`False`
AcceptsMarketingUpdatedAt	`DT_DBTIMESTAMP`	`datetime`		`False`
MarketingOptInLevel	`DT_WSTR`	`nvarchar(255)`	255	`False`
SMSMarketingConsent	`DT_WSTR`	`nvarchar(255)`	255	`False`
AdminGraphQLApiId	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressId	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressCustomerId	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressFirstName	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressLastName	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressCompany	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressAddress1	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressAddress2	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressCity	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressProvince	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressCountry	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressZip	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressPhone	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressName	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressProvinceCode	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressCountryCode	`DT_WSTR`	`nvarchar(255)`	255	`False`
DefaultAddressCountryName	`DT_WSTR`	`nvarchar(255)`	255	`False`
EmailMarketingConsentState	`DT_WSTR`	`nvarchar(255)`	255	`False`
EmailMarketingConsentOptInLevel	`DT_WSTR`	`nvarchar(255)`	255	`False`
EmailMarketingConsentUpdatedAt	`DT_DBTIMESTAMP`	`datetime`		`False`

If the column you are looking for is missing, consider customizing Shopify Connector.

Input Columns

Label	Data Type (SSIS)	Data Type (SQL)	Length	Raw	Description
CustomerId	`DT_I8`	`bigint`		`False`

Required columns that you need to supply are bolded.

Examples

SSIS

Use Shopify Connector in API Source component to read data or in API Destination component to read/write data:

Read from Customers table using API Destination

This Endpoint belongs to Customers table, therefore you cannot work with it directly. Use this table and table-operation pair instead:

Shopify

Customers

Select, Lookup

SSIS API Destination - Access table operation

ODBC application

Use these SQL queries in your ODBC application data source:

Get customers

SELECT * FROM get_customers

Get list of customers

SELECT * FROM Customers

Get a specific customer by its ID

SELECT * FROM Customers Where Id=12345

Get multiple specific customers by their IDs

SELECT * FROM Customers
WITH (ids='1111111111111,2222222222222,3333333333333')

get_customers endpoint belongs to Customers table(s), and can therefore be used via those table(s).

SQL Server

Use these SQL queries in SQL Server after you create a data source in Data Gateway:

Get customers

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM get_customers';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Get list of customers

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Customers';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Get a specific customer by its ID

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Customers Where Id=12345';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

Get multiple specific customers by their IDs

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM Customers
WITH (ids=''1111111111111,2222222222222,3333333333333'')';

EXEC (@MyQuery) AT [LS_TO_SHOPIFY_IN_GATEWAY];

get_customers endpoint belongs to Customers table(s), and can therefore be used via those table(s).