Order Upload

Description

Allows you to create new orders or update existing ones.

Update Mode

Insert or Update

Writeback Fields

Order Header

• id
  • The Shopify assigned order id.
• name
  • The Shopify assigned/generated order name.
• number
  • The Shopify assigned/generated order number.
• subtotal_price
  • The subtotal price before shipping & taxes.
• token
  • Unique identifier for an order.
• total_discounts
  • The total discounts applied to an order.
• total_line_item_price
  • The total sum of the line items.
• total_price
  • The total sum of all line items including taxes, shipping & discounts.
• total_tax
  • The total tax for an order.
• total_weight
  • The total weight for an order.

Updating Orders

To update an existing order specify the Shopify id field on the order header, otherwise to create a new order leave the id blank. If an invalid id is provided an error will be returned by Shopify.

To update a line on an existing specify the valid id assigned to the line item.

It is not presently possible to delete lines from an existing order.

If only the order header fields (such as notes, tags, etc) need to be updated it is not mandatory to specify the Line Items when updating an order.

Line Items

Specifies the line items of an order.

Transactions

The transactions child item are a list of each of the payments associated with a new order. It is not possible to associate a payment with an existing order using this; you must use the transactions upload.

Tax Lines

Specifies any tax details with the order.

Cancel Order Upload

Description

Allows you to cancel existing orders.

Update Mode

Insert (for cancel)

Cancelling An Order

To cancel an order specify the Shopify order id.