Skip to content

Export Customers from Shopify

This task will export a list of customers from your Shopify store, and save them to an XML file.

Settings

Shopify Connection

Required
The Shopify connection to use. See Shopify Connection if you require more information on how to create/manage connections.

Export Settings

  • Date Modified
    Used when exporting modified records. Only records with an updated date higher than this value will be exported. The date will update automatically each time the task runs.

  • Export Modified or All Records
    Select whether you would like the task to export modified or all records from Shopify.

Page Size

Required
Used to control the number of records that are requested from Shopify at a time. Defaults to 100.

Record IDs

Optional
To export specific records from Shopify, enter an ID or comma separated list of IDs. The IDs can be either be specified in integer or global ID format. Examples are shown below:

  • Integer Format - 96382004,96382006
  • Global ID Format - gid://shopify/{object_name}/96382004,gid://shopify/{object_name}/96382006 where {object_name} is replaced with the name of the object, e.g. Customer. More information can be found here.

This will override all other export settings.

Selections

Required
The set of fields to select from Shopify. For more details about the syntax, please refer to Selections Syntax.

For more details about the customer object and it's fields, please refer to Shopify's documentation.

Timeout

Optional
The length of time to wait (in seconds) for Shopify to respond to each API request. If left blank, or set to 0 or less, a default value of 100 seconds will be applied.

Timeout

Optional
The length of time to wait (in seconds) for Shopify to respond to each API request. If left blank, or set to 0 or less, a default value of 100 seconds will be applied.

Zynk Settings

See Common Task Settings

Permissions

This task requires the following permissions in your Shopify app:

  • read_customers

Examples

A sample output file is shown below. The fields returned will vary depending on your selections.

<?xml version="1.0" encoding="utf-8"?>
<Customers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Customer>
    <Id>gid://shopify/Customer/5529424855106</Id>
    <AddressesV2>
      <Record>
        <Id>gid://shopify/MailingAddress/6786848751682?model_name=CustomerAddress</Id>
        <Address1>6 Charlotte Square</Address1>
        <Address2 />
        <City>Newcastle upon Tyne</City>
        <Company>Zynk Software</Company>
        <Country>United Kingdom</Country>
        <CountryCodeV2>GB</CountryCodeV2>
        <FirstName>John</FirstName>
        <LastName>Smith</LastName>
        <Name>John Smith</Name>
        <Phone />
        <Province>England</Province>
        <Zip>NE1 4XH</Zip>
      </Record>
      <Record>
        <Id>gid://shopify/MailingAddress/7227884175426?model_name=CustomerAddress</Id>
        <Address1>Zynk Software Limited</Address1>
        <Address2>i6</Address2>
        <City>Newcastle upon Tyne</City>
        <Country>United Kingdom</Country>
        <CountryCodeV2>GB</CountryCodeV2>
        <FirstName>John</FirstName>
        <LastName>Smith</LastName>
        <Name>John Smith</Name>
        <Province>England</Province>
        <Zip>NE1 4XF</Zip>
      </Record>
    </AddressesV2>
    <CreatedAt>2022-04-20T13:42:32Z</CreatedAt>
    <DefaultAddress>
      <Id>gid://shopify/MailingAddress/7227884175426?model_name=CustomerAddress</Id>
      <Address1>Zynk Software Limited</Address1>
      <Address2>i6</Address2>
      <City>Newcastle upon Tyne</City>
      <Country>United Kingdom</Country>
      <CountryCodeV2>GB</CountryCodeV2>
      <FirstName>John</FirstName>
      <LastName>Smith</LastName>
      <Name>John Smith</Name>
      <Province>England</Province>
      <Zip>NE1 4XF</Zip>
    </DefaultAddress>
    <DefaultEmailAddress>
      <EmailAddress>[email protected]</EmailAddress>
    </DefaultEmailAddress>
    <DefaultPhoneNumber>
      <PhoneNumber>+441918201484</PhoneNumber>
    </DefaultPhoneNumber>
    <FirstName>John</FirstName>
    <LastName>Smith</LastName>
    <Metafields>
      <Record>
        <Id>gid://shopify/Metafield/20546431877186</Id>
        <Key>account_balance</Key>
        <Namespace>custom</Namespace>
        <Type>number_decimal</Type>
        <Value>1000.0</Value>
      </Record>
      <Record>
        <Id>gid://shopify/Metafield/20546431909954</Id>
        <Key>sage_account_code</Key>
        <Namespace>custom</Namespace>
        <Type>single_line_text_field</Type>
        <Value>ADAM0001</Value>
      </Record>
    </Metafields>
    <NumberOfOrders>1</NumberOfOrders>
    <State>DISABLED</State>
    <Tags />
    <TaxExempt>false</TaxExempt>
    <TaxExemptions />
    <UpdatedAt>2023-01-05T14:50:49Z</UpdatedAt>
  </Customer>
</Customers>