Shopify Fulfillment XML

The XML format documented here is used for the import of fulfillments into Shopify, via the Import Order Fulfillments to Shopify task.

We recommend that the external_id field be populated with the unique ID of the fulfillment from the external system, Zynk uses this field to track fulfillments 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"?>
<fulfillments>
  <fulfillment>
    <order-id>4751371664</order-id>
    <order-name>#10523</order-name>
    <location-id>3972354144</location-id>
    <location-name>Newcastle</location-name>
    <notify-customer>false</notify-customer>
    <tracking-company>Fedex</tracking-company>
    <tracking-numbers>
      <tracking-number>67890</tracking-number>
    </tracking-numbers>
    <tracking-urls>
      <tracking-url>https://fedex.com/track?no=67890</tracking-url>
    </tracking-urls>
    <line-items>
      <line-item>
          <id>7152391860</id>
          <fulfillment-line-item-id>9874017354</fulfillment-line-item-id>
          <sku>TFD0121</sku>
          <quantity>2</quantity>
      </line-item>
   </line-items>
  </fulfillment>
</fulfillments>

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

Fulfillment

The following information can be populated at the fulfillment 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
Order	order-id	long	Dependant	Required if an order-name is not specified
Order	order-name	string	Dependant	Required if an order-id is not specified
Location	location-id	long	Dependant	Required if an location-name is not specified
Location	location-name	string	Dependant	Required if an location-id is not specified
Sends notification email to customer	notify-customer	bool	Optional
Shipping carrier	tracking-company	string	Optional
Tracking number	tracking-number	string	Optional
-	tracking-url	string	Optional

<?xml version="1.0" encoding="utf-8"?>
<fulfillments>
  <fulfillment>
    <external_id>12345</external_id>
    <order-id>4751371664</order-id>
    <order-name>#10523</order-name>
    <location-id>3972354144</location-id>
    <location-name>Newcastle</location-name>
    <notify-customer>false</notify-customer>
    <tracking-company>Fedex</tracking-company>
    <tracking-numbers>
      <tracking-number>67890</tracking-number>
    </tracking-numbers>
    <tracking-urls>
      <tracking-url>https://fedex.com/track?no=67890</tracking-url>
    </tracking-urls>
  </fulfillment>
</fulfillments>

Line Items

The following information can be populated at the fulfillment line level.

Shopify Field	XML Field	Type	Input	Notes
SKU	id	string	Dependant	Matches items based on the order line item ID. Must be provided if fulfillment-line-item-id and sku are not provided
SKU	fulfillment-line-item-id	string	Dependant	Matches items based on the fulfilment order line item ID. Must be provided if id and sku are not provided
SKU	sku	string	Dependant	Matches items based on the order line item SKU. Must be provided if id and fulfillment-line-item-id are not provided
Quantity	quantity	Guid	Optional

<?xml version="1.0" encoding="utf-8"?>
<fulfillments>
  <fulfillment>
    <line-items>
      <line-item>
          <id>7152391860</id>
          <fulfillment-line-item-id>9874017354</fulfillment-line-item-id>
          <sku>TFD0121</sku>
          <quantity>2</quantity>
      </line-item>
   </line-items>
  </fulfillment>
</fulfillments>