Skip to content

Shopify Order Update XML

The XML format documented here is used for updating existing orders in Shopify, via the Import Order Updates to Shopify task.

We recommend that the external_id field be populated with the unique ID of the order from the external system, Zynk uses this field to track data already imported into 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"?>
<orders>
  <order>
    <id>4732650881090</id>
    <external_id>123456</external_id>
    <buyer-accepts-marketing>true</buyer-accepts-marketing>
    <email>[email protected]</email>
    <name>#1020</name>
    <note>Leave by the bin</note>
    <note-attributes>
      <note-attribute>
        <name>colour</name>
        <value>red</value>
      </note-attribute>
    </note-attributes>
    <phone>+44191 303 7279</phone>
    <shipping-address>
      <address1>i6 Building</address1>
      <address2>6-8 Charlotte Square</address2>
      <city>Newcastle upon Tyne</city>
      <company>Zynk Software Limited</company>
      <country>United Kingdom</country>
      <country-code>GB</country-code>
      <first-name>John</first-name>
      <last-name>Smith</last-name>
      <province>England</province>
      <province-code>ENG</province-code>
      <zip>NE1 4XF</zip>
    </shipping-address>
    <tags>New,Approved</tags>
    <metafields>
      <metafield>
        <key>expected_delivery_date</key>
        <namespace>custom</namespace>
        <value>2023-05-18T14:00:00</value>
        <type>date_time</type>
      </metafield>
    </metafields>
  </order>
</orders>

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 orders schema is used below as a reference of where fields should be in the object model.

Matching the Order

The order to update is identified based on the following fields. At least one of these fields must be specified.

Shopify Field XML Field  Type  Input  Notes
Order id long Dependant Required if an name is not specified
Order name string Dependant Required if an id is not specified 
<?xml version="1.0" encoding="utf-8"?>
<orders>
  <order>
    <id>4732650881090</id>
    <name>#1020</name>
  </order>
</orders>

Order

The following information can be updated at the order header level.

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
- buyer-accepts-marketing bool Optional
Email email string Optional
Notes note string Optional
Additional Details note-attribute/name string Optional
Additional Details note-attribute/value string Optional
Phone phone string Optional
Tags tags string Optional Multiple tags can be specified as a comma separated list 
<?xml version="1.0" encoding="utf-8"?>
<orders>
  <order>
    <external_id>123456</external_id>
    <buyer-accepts-marketing>true</buyer-accepts-marketing>
    <email>[email protected]</email>
    <note>Leave by the bin</note>
    <note-attributes>
      <note-attribute>
        <name>colour</name>
        <value>red</value>
      </note-attribute>
    </note-attributes>
    <phone>+44191 303 7279</phone>
    <tags>New,Approved</tags>
  </order>
</orders>

Shipping Address

The following information can be updated on the shipping address.

Shopify Field XML Field  Type  Input  Notes
Address address1 string Optional
Apartment, suite, etc address2 string Optional
City city string Optional
Company company string Optional
Country/region country string Optional
Country/region country-code string Optional
First Name first-name string Optional
Last Name last-name string Optional
Province province string Optional
Province province-code string Optional
Postcode zip string Optional 
<?xml version="1.0" encoding="utf-8"?>
<orders>
  <order>
    <shipping-address>
      <address1>i6 Building</address1>
      <address2>6-8 Charlotte Square</address2>
      <city>Newcastle upon Tyne</city>
      <company>Zynk Software Limited</company>
      <country>United Kingdom</country>
      <country-code>GB</country-code>
      <first-name>John</first-name>
      <last-name>Smith</last-name>
      <province>England</province>
      <province-code>ENG</province-code>
      <zip>NE1 4XF</zip>
    </shipping-address>
  </order>
</orders>

Meta Fields

The following information can be found within the 'Metafields' section. The task will attempt to create a new metafield if a matching field doesn't already exist in Shopify.

Shopify Field XML Field  Type  Input  Notes
Definition id long Dependant Used for matching existing metafields. An id or key must be provided.
Namespace namespace string Optional Used in conjunction with key for matching existing metafields
Key key string Dependant Used in conjunction with namespace for matching existing metafields. An id or key must be provided.
Metafield value string Required
Content Type type enum Optional Required to create a new metafield. Valid values are listed below.
  • type - Valid values: boolean, color, date, date_time, dimension, json, money, multi_line_text_field, number_decimal, number_integer, rating, rich_text_field, single_line_text_field, url, volume, weight
<?xml version="1.0" encoding="utf-8"?>
<orders>
  <order>
    <metafields>
      <metafield>
        <key>expected_delivery_date</key>
        <namespace>custom</namespace>
        <value>2023-05-18T14:00:00</value>
        <type>date_time</type>
      </metafield>
    </metafields>
  </order>
</orders>