Shopify File XML

The XML format documented here is used for the upload of files to Shopify, via the Import Files into Shopify task. Please note that existing files can't be updated. We only support the creation of new files.

We recommend that the external_id field be populated with the unique ID of the file from the external system, Zynk uses this field to track files already imported to prevent duplicates being created in Shopify.

XML

Any fields not documented below are not supported by our Shopify connector. Examples of where in the XML the fields should appear are shown in the samples below.

<?xml version="1.0" encoding="utf-8"?>
<files>
  <file>
    <!-- Example showing how to upload a local file to Shopify -->
    <external_id>123</external_id>
    <file-path>invoice_123.pdf</file-path> 
    <mime-type>application/pdf</mime-type>
    <content-type>FILE</content-type>
    <alt-text>Invoice 123</alt-text>
  </file>
  <file>
    <!-- Example showing how to link a file hosted on the web to Shopify -->
    <external_id>124</external_id>
    <file-url>https://zynk.com/wp-content/uploads/2018/02/sitelogo100.png</file-url>
    <content-type>IMAGE</content-type>
    <alt-text>Zynk Logo</alt-text>
  </file>
</files>

In each of the following sections most of the XML has been omitted to make the samples easier to read. The whole structure of the files schema is used below as a reference of where fields should be in the object model.

Uploading a Local File to Shopify

The following information can be provided when uploading a file stored the local network to Shopify.

Shopify Field	XML Field	Type	Input	Notes
-	external_id	string	Optional	Stored in Zynk's internal DB and used in conjunction with the 'Prevent Reprocessing' setting
File name	file-path	string	Required	The absolute or relative path to the file
-	mime-type	string	Optional	Will be set based on the file extension if not specified
-	content-type	enum	Optional	Valid values: IMAGE, VIDEO, FILE. Defaults to FILE if not specified
-	alt-text	string	Optional

<?xml version="1.0" encoding="utf-8"?>
<files>
  <file>
    <external_id>123</external_id>
    <file-path>invoice_123.pdf</file-path>
    <mime-type>application/pdf</mime-type>
    <content-type>FILE</content-type>
    <alt-text>Invoice 123</alt-text>
  </file>
</files>

Linking a File on the Web to Shopify

The following information can be provided when linking a file hosted on the web to Shopify.

Shopify Field	XML Field	Type	Input	Notes
-	external_id	string	Optional	Used in conjunction with the 'Prevent Reprocessing' setting
File name	file-url	string	Required	The URL of the file
-	content-type	enum	Optional	Valid values: IMAGE, VIDEO, FILE. Defaults to FILE if not specified
-	alt-text	string	Optional

<?xml version="1.0" encoding="utf-8"?>
<files>
  <file>
    <external_id>124</external_id>
    <file-url>https://zynk.com/wp-content/uploads/2018/02/sitelogo100.png</file-url>
    <content-type>IMAGE</content-type>
    <alt-text>Zynk Logo</alt-text>
  </file>
</files>