Export Products from Shopify

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

Important

This task uses Shopify's REST API, which is now deprecated. We recommend migrating to the equivalent GraphQL API task. See here for more information.

Settings

Connection

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

Export Inventory Items

Required
Optionally include inventory item information for each variant exported from Shopify.

Export Inventory Levels

Required
Optionally include inventory level information for each variant exported from Shopify.

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.

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 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.

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.

Status

Required
Used to filter the products that will be exported by the task, based on published status. Set to Any to export products regardless of their published status, or choose a specific status to export:-

Any
Published
Unpublished

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 products to.

Zynk Settings

See Common Task Settings.

Permissions

This task requires the following permissions in your Shopify app:

read_products
read_locations
read_inventory (if the 'Export Inventory Items' or 'Export Inventory Levels' setting is enabled)

Examples

Sample output file:

<?xml version="1.0" encoding="utf-8"?>
<products type="array" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <product>
    <id>8345921744</id>
    <created-at>2017-02-21T15:49:42+00:00</created-at>
    <updated-at>2023-03-16T14:44:19+00:00</updated-at>
    <body-html />
    <handle>stripey-flag</handle>
    <images />
    <options>
      <option>
        <id>10001283920</id>
        <product-id>8345921744</product-id>
        <name>Title</name>
        <position>1</position>
        <values>
          <value>Default Title</value>
        </values>
      </option>
    </options>
    <product-type />
    <published-at>2017-02-21T15:49:42+00:00</published-at>
    <published-scope>web</published-scope>
    <status>active</status>
    <tags />
    <title>! Stripey Flag</title>
    <variants>
      <variant>
        <id>29825602704</id>
        <created-at>2017-02-21T15:49:42+00:00</created-at>
        <updated-at>2023-03-16T14:44:19+00:00</updated-at>
        <available xsi:nil="true" />
        <barcode>123456789</barcode>
        <compare-at-price xsi:nil="true" />
        <fulfillment-service>manual</fulfillment-service>
        <grams>0</grams>
        <image-id xsi:nil="true" />
        <inventory-item-id>19177384016</inventory-item-id>
        <inventory-item>
          <id>19177384016</id>
          <created-at>2017-02-21T15:49:42+00:00</created-at>
          <updated-at>2023-03-16T14:44:18+00:00</updated-at>
          <cost xsi:nil="true" />
          <country-code-of-origin>GB</country-code-of-origin>
          <harmonized-system-code>6603203000</harmonized-system-code>
          <sku>MEREXC1</sku>
          <tracked>true</tracked>
          <requires-shipping>true</requires-shipping>
        </inventory-item>
        <inventory_levels>
          <inventory_levels>
            <inventory_item_id>19177384016</inventory_item_id>
            <location_id>11701904</location_id>
            <locations>
              <id>11701904</id>
              <created-at>2016-12-14T21:15:03+00:00</created-at>
              <updated-at>2017-09-01T17:16:35+01:00</updated-at>
              <active>true</active>
              <address1>185 Rideau Street</address1>
              <city>Ottawa</city>
              <country>CA</country>
              <country-code>CA</country-code>
              <legacy>false</legacy>
              <name>185 Rideau Street</name>
              <province>Ontario</province>
              <province-code>ON</province-code>
              <zip>K1N 5X8</zip>
              <localized-country-name>Canada</localized-country-name>
              <localized-province-name>Ontario</localized-province-name>
            </locations>
            <available>93</available>
            <updated_at>2022-12-29T16:20:56+00:00</updated_at>
            <admin_graphql_api_id>gid://shopify/InventoryLevel/1837840?inventory_item_id=19177384016</admin_graphql_api_id>
          </inventory_levels>
          <inventory_levels>
            <inventory_item_id>19177384016</inventory_item_id>
            <location_id>37000511554</location_id>
            <locations>
              <id>37000511554</id>
              <created-at>2021-01-15T14:09:07+00:00</created-at>
              <updated-at>2022-01-27T16:09:53+00:00</updated-at>
              <active>true</active>
              <address1>Charlotte Square</address1>
              <address2 />
              <city>Newcastle upon Tyne</city>
              <country>GB</country>
              <country-code>GB</country-code>
              <legacy>false</legacy>
              <name>Newcastle</name>
              <phone />
              <province>England</province>
              <province-code>ENG</province-code>
              <zip>NE1</zip>
              <localized-country-name>United Kingdom</localized-country-name>
              <localized-province-name>England</localized-province-name>
            </locations>
            <available>96</available>
            <updated_at>2022-01-27T16:09:02+00:00</updated_at>
            <admin_graphql_api_id>gid://shopify/InventoryLevel/70890356802?inventory_item_id=19177384016</admin_graphql_api_id>
          </inventory_levels>
        </inventory_levels>
        <inventory-management>shopify</inventory-management>
        <inventory-policy>deny</inventory-policy>
        <inventory-quantity>189</inventory-quantity>
        <option1>Default Title</option1>
        <position>1</position>
        <price>25.00</price>
        <product-id>8345921744</product-id>
        <sku>MEREXC1</sku>
        <taxable>true</taxable>
        <title>Default Title</title>
        <weight>0.0</weight>
        <weight-unit>kg</weight-unit>
      </variant>
    </variants>
    <vendor>Price, Towne and Kulas</vendor>
  </product>
</products>