Export Orders from Shopify

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

Settings

Connection

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

Export Customer Meta Fields

Required
Optionally export the custom meta data for customer records. Set to True to export all customer meta data, otherwise False to not have the data included. Defaults to False.

Export Fulfillment Order

Required
Optionally export fulfillment order information for each order from Shopify.

Export Order Meta Fields

Required
Optionally export the custom meta data for order records. Set to True to export all order meta data, otherwise False to not have the data included. Defaults to False.

Export Product Meta Fields

Required
Optionally export the custom meta data for product records. Set to True to export all product meta data, otherwise False to not have the data included. Defaults to False.

The 'Export Products' setting must be enabled for this setting to take effect.

Export Products

Required
Optionally export the product information related to each line item.

Export Risks

Required
Optionally export risk information for each order from Shopify.

Export Settings

• Date Created
  Used when exporting new records.

• Date Modified
  Used when exporting modified records.

• Export Modified, New or All Records
  If modified, new or all records should be exported.

Export Shopify Payments Transactions

Required
Optionally export the charge transactions associated with each order placed via the Shopify Payments gateway. Set to True to include where applicable, otherwise False not attempt to export. Defaults to False.

Export Transactions

Required
Optionally export the transactions related to the order record.

Export Variant Meta Fields

Required
Optionally export the custom meta data for variant records. Set to True to export all variant meta data, otherwise False to not have the data included. Defaults to False.

The 'Export Variants' setting must be enabled for this setting to take effect.

Export Variants

Required
Optionally export the variant information related to each line item.

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
• Paid
• Partially_Paid
• Partially_Refunded
• Pending
• Refunded
• Unpaid
• 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
• Partial
• Shipped
• Unfulfilled
• Unshipped

Page Size

Required
Used to control the number of records that are exported per page. Defaults to 100.

Record IDs

Optional
The number of records to export per page. Please note, this is the Shopify ID present in the URL rather than the Shopify Order Number.

Start Date

Required
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
• Open
• Closed
• Cancelled

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.

Output File

Required
The XML file to save the list of orders to.

Zynk Settings

See Common Task Settings.

Permissions

This task requires the following permissions in your Shopify app:

• read_orders
• read_assigned_fulfillment_orders (if the 'Export Fulfillment Order' setting is enabled)
• read_merchant_managed_fulfillment_orders (if the 'Export Fulfillment Order' setting is enabled)
• read_products (if the 'Export Products' setting is enabled)

Examples

Sample output file:

<?xml version="1.0" encoding="utf-8"?>
<orders type="array" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <order>
    <id>4732650881090</id>
    <created-at>2022-12-29T16:26:13+00:00</created-at>
    <updated-at>2022-12-30T09:17:54+00:00</updated-at>
    <app-id>580111</app-id>
    <billing-address>
      <address1>Zynk Software Limited</address1>
      <address2>i6</address2>
      <city>Newcastle upon Tyne</city>
      <country>United Kingdom</country>
      <country-code>GB</country-code>
      <customer-id xsi:nil="true" />
      <default xsi:nil="true" />
      <first-name>John</first-name>
      <last-name>Smith</last-name>
      <name>John Smith</name>
      <province>England</province>
      <province-code>ENG</province-code>
      <zip>NE1 4XF</zip>
    </billing-address>
    <browser-ip>217.23.234.104</browser-ip>
    <buyer-accepts-marketing>true</buyer-accepts-marketing>
    <cancelled-at xsi:nil="true" />
    <cart-token>e83e7e7480a6dde23ba8a5060f215869</cart-token>
    <checkout-id>30461507240002</checkout-id>
    <checkout-token>e0496e5da1d69a5c34d37da9e2836c88</checkout-token>
    <client-details>
      <accept-language>en-GB</accept-language>
      <browser-height xsi:nil="true" />
      <browser-ip>217.23.234.104</browser-ip>
      <browser-width xsi:nil="true" />
      <user-agent>Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:108.0) Gecko/20100101 Firefox/108.0</user-agent>
    </client-details>
    <closed-at xsi:nil="true" />
    <company>
      <id>182772</id>
      <location-id>753095</location-id>
    </company>
    <confirmation-number>TLQDA3NN9</confirmation-number>
    <confirmed>true</confirmed>
    <contact-email>[email protected]</contact-email>
    <currency>GBP</currency>
    <current-total-additional-fees-set>
      <shop-money>
        <amount>0.00</amount>
        <currency-code>GBP</currency-code>
      </shop-money>
      <presentment-money>
        <amount>0.00</amount>
        <currency-code>GBP</currency-code>
      </presentment-money>
    </current-total-additional-fees-set>
    <current-total-discounts>0.00</current-total-discounts>
    <current-total-discounts-set>
      <shop-money>
        <amount>0.00</amount>
        <currency-code>GBP</currency-code>
      </shop-money>
      <presentment-money>
        <amount>0.00</amount>
        <currency-code>GBP</currency-code>
      </presentment-money>
    </current-total-discounts-set>
    <current-total-price>136.91</current-total-price>
    <current-total-price-set>
      <shop-money>
        <amount>136.91</amount>
        <currency-code>GBP</currency-code>
      </shop-money>
      <presentment-money>
        <amount>136.91</amount>
        <currency-code>GBP</currency-code>
      </presentment-money>
    </current-total-price-set>
    <current-subtotal-price>116.91</current-subtotal-price>
    <current-subtotal-price-set>
      <shop-money>
        <amount>116.91</amount>
        <currency-code>GBP</currency-code>
      </shop-money>
      <presentment-money>
        <amount>116.91</amount>
        <currency-code>GBP</currency-code>
      </presentment-money>
    </current-subtotal-price-set>
    <current-total-tax>0.00</current-total-tax>
    <current-total-tax-set>
      <shop-money>
        <amount>0.00</amount>
        <currency-code>GBP</currency-code>
      </shop-money>
      <presentment-money>
        <amount>0.00</amount>
        <currency-code>GBP</currency-code>
      </presentment-money>
    </current-total-tax-set>
    <customer>
      <id>5529424855106</id>
      <created-at>2022-04-20T14:42:32+01:00</created-at>
      <updated-at>2023-01-05T14:50:49+00:00</updated-at>
      <currency>GBP</currency>
      <default-address>
        <id>7227884175426</id>
        <address1>Zynk Software Limited</address1>
        <address2>i6</address2>
        <city>Newcastle upon Tyne</city>
        <country>United Kingdom</country>
        <country-code>GB</country-code>
        <country-name>United Kingdom</country-name>
        <customer-id>5529424855106</customer-id>
        <default>true</default>
        <first-name>John</first-name>
        <last-name>Smith</last-name>
        <name>John Smith</name>
        <province>England</province>
        <province-code>ENG</province-code>
        <zip>NE1 4XF</zip>
      </default-address>
      <email>[email protected]</email>
      <email-marketing-consent>
        <state>subscribed</state>
        <opt-in-level>single_opt_in</opt-in-level>
        <consent-updated-at>2022-12-29T16:26:14+00:00</consent-updated-at>
      </email-marketing-consent>
      <first-name>John</first-name>
      <last-name>Smith</last-name>
      <last-order-id xsi:nil="true" />
      <note />
      <orders-count xsi:nil="true" />
      <state>disabled</state>
      <tags />
      <tax-exempt>false</tax-exempt>
      <tax-exemptions />
      <total-spent xsi:nil="true" />
      <verified-email>true</verified-email>
    </customer>
    <customer-locale>en-GB</customer-locale>
    <discount-applications />
    <discount-codes />
    <email>[email protected]</email>
    <estimated-taxes>false</estimated-taxes>
    <financial-status>paid</financial-status>
    <fulfillments />
    <landing-site>/</landing-site>
    <line-items>
      <line-item>
        <fulfillable-quantity>9</fulfillable-quantity>
        <fulfillment-service>manual</fulfillment-service>
        <gift-card>false</gift-card>
        <grams>0</grams>
        <id>11932447440962</id>
        <name>Milestone Baby Cards</name>
        <price>12.99</price>
        <price-set>
          <shop-money>
            <amount>12.99</amount>
            <currency-code>GBP</currency-code>
          </shop-money>
          <presentment-money>
            <amount>12.99</amount>
            <currency-code>GBP</currency-code>
          </presentment-money>
        </price-set>
        <product-exists>true</product-exists>
        <product-id>8345855632</product-id>
        <properties />
        <quantity>9</quantity>
        <requires-shipping>true</requires-shipping>
        <sku>1TMILESTONE</sku>
        <taxable>true</taxable>
        <title>Milestone Baby Cards</title>
        <total-discount>0.00</total-discount>
        <total-discount-set>
          <shop-money>
            <amount>0.00</amount>
            <currency-code>GBP</currency-code>
          </shop-money>
          <presentment-money>
            <amount>0.00</amount>
            <currency-code>GBP</currency-code>
          </presentment-money>
        </total-discount-set>
        <variant-id>29825060880</variant-id>
        <vendor>Price, Towne and Kulas</vendor>
        <tax-lines />
        <discount-allocations />
        <duties />
      </line-item>
    </line-items>
    <location-id xsi:nil="true" />
    <merchant-of-record-app-id xsi:nil="true" />
    <name>#1020</name>
    <note-attributes />
    <number>20</number>
    <order-number>1020</order-number>
    <original-total-additional-fees-set>
      <shop-money>
        <amount>0.00</amount>
        <currency-code>GBP</currency-code>
      </shop-money>
      <presentment-money>
        <amount>0.00</amount>
        <currency-code>GBP</currency-code>
      </presentment-money>
    </original-total-additional-fees-set>
    </original-total-additional-fees-set>
    <payment-gateway-names>
      <payment-gateway-name>Cash on Delivery (COD)</payment-gateway-name>
    </payment-gateway-names>
    <phone>+441913037279</phone>
    <po-number>PO-12345</po-number>
    <presentment-currency>GBP</presentment-currency>
    <processed-at>2022-12-29T16:26:11+00:00</processed-at>
    <reference>db5f4799c551f0af0404bb959717269d</reference>
    <referring-site />
    <refunds />
    <shipping-address>
      <address1>Zynk Software Limited</address1>
      <address2>i6</address2>
      <city>Newcastle upon Tyne</city>
      <country>United Kingdom</country>
      <country-code>GB</country-code>
      <customer-id xsi:nil="true" />
      <default xsi:nil="true" />
      <first-name>John</first-name>
      <last-name>Smith</last-name>
      <latitude>54.971099</latitude>
      <longitude>-1.620134</longitude>
      <name>John Smith</name>
      <province>England</province>
      <province-code>ENG</province-code>
      <zip>NE1 4XF</zip>
    </shipping-address>
    <shipping-lines>
      <shipping-line>
        <id>3882387669058</id>
        <carrier-identifier>650f1a14fa979ec5c74d063e968411d4</carrier-identifier>
        <code>International Shipping</code>
        <discount-allocations />
        <discounted-price>20.00</discounted-price>
        <discounted-price-set>
          <shop-money>
            <amount>20.00</amount>
            <currency-code>GBP</currency-code>
          </shop-money>
          <presentment-money>
            <amount>20.00</amount>
            <currency-code>GBP</currency-code>
          </presentment-money>
        </discounted-price-set>
        <price>20.00</price>
        <price-set>
          <shop-money>
            <amount>20.00</amount>
            <currency-code>GBP</currency-code>
          </shop-money>
          <presentment-money>
            <amount>20.00</amount>
            <currency-code>GBP</currency-code>
          </presentment-money>
        </price-set>
        <requested-fulfillment-service-id xsi:nil="true" />
        <source>shopify</source>
        <tax-lines />
        <title>International Shipping</title>
      </shipping-line>
    </shipping-lines>
    <source-identifier>db5f4799c551f0af0404bb959717269d</source-identifier>
    <source-name>web</source-name>
    <subtotal-price>116.91</subtotal-price>
    <subtotal-price-set>
      <shop-money>
        <amount>116.91</amount>
        <currency-code>GBP</currency-code>
      </shop-money>
      <presentment-money>
        <amount>116.91</amount>
        <currency-code>GBP</currency-code>
      </presentment-money>
    </subtotal-price-set>
    <tags />
    <tax-exempt>false</tax-exempt>
    <tax-lines />
    <taxes-included>false</taxes-included>
    <test>false</test>
    <token>a4a64718710895c93cfd59bdb1b6a280</token>
    <total-discounts>0.00</total-discounts>
    <total-discounts-set>
      <shop-money>
        <amount>0.00</amount>
        <currency-code>GBP</currency-code>
      </shop-money>
      <presentment-money>
        <amount>0.00</amount>
        <currency-code>GBP</currency-code>
      </presentment-money>
    </total-discounts-set>
    <total-line-items-price>116.91</total-line-items-price>
    <total-line-items-price-set>
      <shop-money>
        <amount>116.91</amount>
        <currency-code>GBP</currency-code>
      </shop-money>
      <presentment-money>
        <amount>116.91</amount>
        <currency-code>GBP</currency-code>
      </presentment-money>
    </total-line-items-price-set>
    <total-outstanding>0.00</total-outstanding>
    <total-price>136.91</total-price>
    <total-price-set>
      <shop-money>
        <amount>136.91</amount>
        <currency-code>GBP</currency-code>
      </shop-money>
      <presentment-money>
        <amount>136.91</amount>
        <currency-code>GBP</currency-code>
      </presentment-money>
    </total-price-set>
    <total-shipping-price-set>
      <shop-money>
        <amount>20.00</amount>
        <currency-code>GBP</currency-code>
      </shop-money>
      <presentment-money>
        <amount>20.00</amount>
        <currency-code>GBP</currency-code>
      </presentment-money>
    </total-shipping-price-set>
    <total-tax>0.00</total-tax>
    <total-tax-set>
      <shop-money>
        <amount>0.00</amount>
        <currency-code>GBP</currency-code>
      </shop-money>
      <presentment-money>
        <amount>0.00</amount>
        <currency-code>GBP</currency-code>
      </presentment-money>
    </total-tax-set>
    <total-tip-received>0.00</total-tip-received>
    <total-weight>0</total-weight>
    <user-id xsi:nil="true" />
    <order-status-url>https://price-towne-and-kulas6468.myshopify.com/1760870/orders/a4a64718710895c93cfd59bdb1b6a280/authenticate?key=37bf6ee7dcc60e48b659213006ec0d23</order-status-url>
  </order>
</orders>