Export Orders from Shopify
This task will export a list of orders 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.
Channel
Optional
Filter the export by channel handle. For example 'web,pos'.
Export Settings
-
Date Created
Used when exporting new records. Only records with a created date higher than this value will be exported. The date will update automatically each time the task runs. -
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, New or All Records
Select whether you would like the task to export new, modified, or all records from Shopify.
Financial Status
Required
Used to filter the records that will be exported by the task. Set to any
to export orders regardless of financial status, or choose a specific status to include:-
- any
- authorized
- expired
- paid
- partially_paid
- partially_refunded
- pending
- refunded
- voided
Fulfillment Status
Required
Used to filter the records that will be exported by the task. Set to any
to export orders regardless of fulfillment status, or choose a specific status to include:-
- any
- fulfilled
- on_hold
- partial
- request_declined
- scheduled
- unfulfilled
Gateway
Optional
Filter the export by payment gateway name.
Order Name
Optional
Filter the export by order name.
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 order object and it's fields, please refer to Shopify's documentation.
Start Date
Optional
Used as a fixed date to start exporting orders from, only orders created after the specified value will be returned. If you have been processing orders prior to deploying an integration it can be helpful to restrict previously processed orders. Defaults to the current datetime when the task is created.
Status
Required
Used to filter the records that will be exported by the task. Set to any
to export orders regardless of status, or choose a specific status to include:-
- any
- cancelled
- closed
- not_closed
- open
Tag
Optional
Filter the export by tag.
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
Permissions
This task requires the following permissions in your Shopify app:
- read_orders
Examples
A sample output file is shown below. The fields returned will vary depending on your selections.
<?xml version="1.0" encoding="utf-8"?>
<Orders xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<Order>
<Id>gid://shopify/Order/2712001511490</Id>
<BillingAddress>
<Id>gid://shopify/MailingAddress/6881456128066?model_name=Address</Id>
<Address1>i6 Building</Address1>
<Address2>6-8 Charlotte Square</Address2>
<City>Newcastle</City>
<Company>Zynk Software</Company>
<Country>United Kingdom</Country>
<CountryCodeV2>GB</CountryCodeV2>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Name>John Smith</Name>
<Phone>0123456789</Phone>
<Province>Tyne & Wear</Province>
<Zip>NE1 4XF</Zip>
</BillingAddress>
<CreatedAt>2021-01-15T14:26:21Z</CreatedAt>
<DiscountApplications />
<FullyPaid>true</FullyPaid>
<LineItems>
<Record>
<Id>gid://shopify/LineItem/5800794685506</Id>
<Name>! Stripey Flag</Name>
<OriginalUnitPriceSet>
<PresentmentMoney>
<Amount>2.25</Amount>
</PresentmentMoney>
</OriginalUnitPriceSet>
<Quantity>1</Quantity>
<Sku>MEREXC1</Sku>
<TaxLines />
<TotalDiscountSet>
<PresentmentMoney>
<Amount>0.0</Amount>
</PresentmentMoney>
</TotalDiscountSet>
</Record>
<Record>
<Id>gid://shopify/LineItem/5800794718274</Id>
<Name>A Flag Pink Stripey</Name>
<OriginalUnitPriceSet>
<PresentmentMoney>
<Amount>2.25</Amount>
</PresentmentMoney>
</OriginalUnitPriceSet>
<Quantity>1</Quantity>
<Sku>MER99A4</Sku>
<TaxLines />
<TotalDiscountSet>
<PresentmentMoney>
<Amount>0.0</Amount>
</PresentmentMoney>
</TotalDiscountSet>
</Record>
</LineItems>
<Metafields />
<Name>#1017</Name>
<NetPaymentSet>
<PresentmentMoney>
<Amount>4.5</Amount>
</PresentmentMoney>
</NetPaymentSet>
<PaymentGatewayNames>
<PaymentGatewayName>manual</PaymentGatewayName>
</PaymentGatewayNames>
<PresentmentCurrencyCode>GBP</PresentmentCurrencyCode>
<PurchasingEntity xsi:type="Customer">
<Id>gid://shopify/Customer/96430088</Id>
<Email>[email protected]</Email>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Tags />
</PurchasingEntity>
<ShippingAddress>
<Id>gid://shopify/MailingAddress/6881456095298?model_name=Address</Id>
<Address1>i6 Building</Address1>
<Address2>6-8 Charlotte Square</Address2>
<City>Newcastle</City>
<Company>Zynk Software</Company>
<Country>United Kingdom</Country>
<CountryCodeV2>GB</CountryCodeV2>
<FirstName>John</FirstName>
<LastName>Smith</LastName>
<Name>John Smith</Name>
<Phone>0123456789</Phone>
<Province>Tyne & Wear</Province>
<Zip>NE1 4XF</Zip>
</ShippingAddress>
<SubtotalPriceSet>
<PresentmentMoney>
<Amount>4.5</Amount>
</PresentmentMoney>
</SubtotalPriceSet>
<Tags />
<TaxesIncluded>false</TaxesIncluded>
<TaxExempt>false</TaxExempt>
<TotalDiscountsSet>
<PresentmentMoney>
<Amount>0.0</Amount>
</PresentmentMoney>
</TotalDiscountsSet>
<TotalPriceSet>
<PresentmentMoney>
<Amount>4.5</Amount>
</PresentmentMoney>
</TotalPriceSet>
<TotalShippingPriceSet>
<PresentmentMoney>
<Amount>0.0</Amount>
</PresentmentMoney>
</TotalShippingPriceSet>
<TotalTaxSet>
<PresentmentMoney>
<Amount>0.0</Amount>
</PresentmentMoney>
</TotalTaxSet>
<UpdatedAt>2021-01-15T14:29:40Z</UpdatedAt>
</Order>
</Orders>