Order CSV column descriptions

Descriptions of the columns for the orders CSV file.

To import orders into Shopify using the Transporter app, you need a CSV file that contains only this record type.

CSV sample file

Download the sample orders CSV file: orders.csv

You can use the Transporter command-line tool to generate this CSV file or you can follow the format described below to create it yourself.

Column descriptions

The following table describes the column headers for the CSV file.

Order CSV column headers
Column Description
Name (Required)
The identifier of the order that you see in your Shopify admin and your customer sees on their invoice. This identifier needs to be unique within your store. For example, #1001, 1001-A, and SH1001. This column is required.
Email The email address of the customer.
Financial Status The status of payments associated with the order. Valid values:
  • pending - The payments are pending. Payment might fail in this state. Check again to confirm whether the payments have been paid successfully.
  • authorized - The payments have been authorized.
  • partially_paid - The order has been partially paid.
  • paid - The payments have been paid.
  • partially_refunded - The payments have been partially refunded.
  • refunded - The payments have been refunded.
  • voided - The payments have been voided.
Values are case sensitive.
Fulfillment Status The order's status in terms of fulfilled line items. Valid values:
  • fulfilled - Every line item in the order has been fulfilled.
  • partial - At least one line item in the order has been fulfilled.
  • restocked - Every line item in the order has been restocked and the order canceled.
  • Leaving this column blank results in an unfulfilled order status.
Values are case sensitive. Order fulfillment status should be based on the status of individual line item(s). Refer to Order fulfillment status below for more information.
Currency The three-letter code (ISO 4217 format) for the currency used for the payment. For example, USD or EUR.
Buyer Accepts Marketing Whether a customer has opted in to receive marketing. Valid values:
  • TRUE - The customer is opted in to receiving marketing.
  • FALSE - The customer is opted out of receiving marketing.
Cancel Reason The reason why the order was canceled. Valid values:
  • customer - The customer canceled the order.
  • fraud - The order was fraudulent.
  • inventory - Items in the order were not in inventory.
  • declined - The payment was declined.
  • other - A reason not in this list.
Values are case sensitive.
Cancelled At The date and time (ISO 8601 format) when the order was canceled.
Closed At The date and time (ISO 8601 format) when the order was closed.
Tags A string of comma-separated tags that are used for filtering and search. Each comma-separated tag can have up to 255 characters. For example, "Reviewed, Packed, Delivered".
Note An optional note attached to the order. This note can be viewed by the customer. For example, "Customer changed their mind."
Phone The unique phone number (E.164 format) for the customer. A phone number can be entered using different formats, but each format must represent a number that can be dialed from anywhere in the world. The following formats are all valid:
6135551212
+16135551212
(613)555-1212
+1 613-555-1212
Referring Site The website where the customer clicked a link that led them to your store. For example, "http://www.anexample.com"
Processed At

The date and time (ISO 8601 format) when the order was originally created in the other platform. This value appears on the order in your Shopify admin, and it's the date used in sales reports. The default value is the date and time of when the order is imported.

For values that affect the analytics for finance and payments, refer to Transaction Processed At.

Source name Where the order originated (for example, the name of the platform). This value cannot be edited after the import. For example, Transporter.
Total weight The sum of all line item weights (formatted as an integer) in grams. For example, 11.
Total Tax The sum of all the taxes (Tax 1 Price, ..., Shipping 1 Tax Rate) applied to the order (must be a positive number). This column is required when any tax is charged as part of the order (for example, when there is a value in the Tax Price 1 column). If you don't include a value for this column, then the total value in your order won't include any tax charges.
Shipping Company The name of the business, if one exists associated with the shipping address.
Shipping Name The full name of the person associated with the shipping address. An address needs to have a name associated with it. You can do that by using Shipping Name or by using Shipping First Name and Shipping Last Name.
Shipping Phone The phone number (E.164 format) associated with the shipping address. A phone number can be entered using different formats, but each format must represent a number that can be dialed from anywhere in the world. The following formats are all valid:
6135551212
+16135551212
(613)555-1212
+1 613-555-1212
Shipping First Name The first name of the person associated with the shipping address. An address needs to have a name associated with it. You can do that by using Shipping First Name and Shipping Last Name or by using Shipping Name.
Shipping Last Name The last name of the person associated with the shipping address. An address needs to have a name associated with it. You can do that by using Shipping First Name and Shipping Last Name or by using Shipping Name.
Shipping Address1 The first address line of the shipping address. This column is required for an address. For example, 150 Elgin St.
Shipping Address2 An optional address line of the shipping address. For example, Unit 202.
Shipping City The name of city of the shipping address. This column is required for a shipping address. For example, Ottawa or Sydney.
Shipping Province The name of the region (such as the province, state, prefecture, or territory), where the customer is located. If you include this column, then the Shipping Province Code column is required. For example, Mexico city, Tasmania, New South Wales, or New York.
Shipping Province Code The subdivision assigned code (ISO 3166-2) for the region, such as the state, province, prefecture, or territory, in the country. This column is required when you include the Shipping Province column. An ISO3116-2 code has the following parts:
  • 2-character country code - do not include this part.
  • hyphen (-) that separates the two parts of the code - do not include the hyphen.
  • 1-to-3-character subdivision code - include this part only.
Subdivision codes
ISO 3166-2 subdivision code Province code
MX-MEX (Mexico City, Mexico) MEX
NY-US (New York, United States) NY
Ar-B (Buenos Aires, Argentina) B
FR-21 (Côte-d'Or, France) 21
Shipping Zip The zip code, postal code, or postcode of the customer address. For example, K2P 1L4, 90210, or 110 012.
Shipping Country The name of the country of the shipping address. This column is required for an address. For example, Canada, India, or Australia.
Shipping Country Code The two-letter (ISO 3166-1 alpha-2 code) for the country of the customer address. For example, CA for Canada. Specify the Shipping Country code even when you specify Shipping Country.
Billing Company The company of the person associated with the billing address.
Billing Name The full name of the customer associated with the payment. An address needs to have a name associated with it. You can do that by using Billing Name or by using Billing First Name and Billing Last Name.
Billing Phone The phone number (E.164 format) associated with the billing address. A phone number can be entered using different formats, but each format must represent a number that can be dialed from anywhere in the world. The following formats are valid:
6135551212
+16135551212
(613)555-1212
+1 613-555-1212
Billing First Name The first name of the person associated with the payment method. An address needs to have a name associated with it. You can do that by using Billing First Name and Billing Last Name or by using Billing Name.
Billing Last Name The last name of the person associated with the payment method. An address needs to have a name associated with it. You can do that by using Billing First Name and Billing Last Name or by using Billing Name.
Billing Address1 The first address line of the billing address. For example, 150 Elgin St. This column is required for a billing address.
Billing Address2 An optional address line of the billing address. For example, Unit 202.
Billing City The name of the city of the billing address. This column is required for a billing address. For example, Ottawa, Delhi, and Auckland.
Billing Province The name of the region (such as the province, state, prefecture, or territory), where the billing address is located. If you include this column, then the Shipping Province Code column is required. For example, Mexico city, New York, or Nunavut, and New South Wales.
Billing Province Code The subdivision code ( ISO 3166-2) for the region, such as the state, province, prefecture, or territory, in the country. This column is required when you specify the Billing Province column. An ISO3116-2 code has the following parts:
  • 2-character country code - do not include this part.
  • hyphen (-) that separates the two parts of the code - do not include the hyphen.
  • 1-to-3-character subdivision code - include this part only.
Subdivision codes
ISO 3166-2 subdivision code Province code
MX-MEX (Mexico City, Mexico) MEX
US-NY (New York, United States) NY
AR-B (Buenos Aires, Argentina) B
FR-21 (Côte-d'Or, France) 21
Billing Zip The zip, postal code, or postcode of the billing address. For example, K2P 1L4.
Billing Country The name of the country of the billing address. This column is required for a billing address. For example, Canada, India, and Germany.
Billing Country Code The two-letter (ISO 3166-1 alpha-2 code) for the country of the billing address. For example, CA for Canada. Specify the Country code even when you specify Country.
Lineitem name (Required)
The name of the product variant that was ordered. For example, Blue shirt. This column is required.
Lineitem variant ID The ID of the product variant that was ordered. Use this column to connect the item in this order to a product variant that exists in your store. For example, 7513594. You need to make sure that the ID in this column matches a product variant ID from your store, or leave this column empty. If the Transporter app can't find a product variant in your store that matches the ID in this column, then the import isn't affected. The product will still be added to the order, but won't be matched to a product in your store for analytics purposes.
Lineitem quantity The number of product variants that were ordered. This column accepts only positive integers. The default is 1. For example, 3.
Lineitem price (Required)
The price of the product variant before any discounts have been applied. For example, 10.50 .25, and 30. This column is required.
Lineitem variant title The specific product variant. For example Small.
Lineitem compare at price A comparison or suggested price of the product variant. For example, 15.
Lineitem sku The item's (product variant's) SKU (stock keeping unit) number.
Lineitem requires shipping Whether the product variant required shipping. Valid values:
  • true - The item requires shipping.
  • false - The item doesn't require shipping
Values are case sensitive.
Lineitem taxable Whether the product variant was taxable. Valid values:
  • true - The item is taxable.
  • false - The item is not taxable.
Values are case sensitive.
Lineitem fulfillment status The fulfillment status of individual line items in an order. Valid values:
  • fulfilled - Every product in the line item has been fulfilled.
  • Leaving this column blank results in an unfulfilled line item status.
Values are case sensitive. The fulfillment status of individual line items should be used to determine the status of the order as a whole. Refer to Order fulfillment status below for more information.
Taxes Included Whether the taxes were included in the original order. Valid values:
  • true - Taxes are included in the subtotal. When this value is set to true, all taxes are included in the price, including line item taxes and any tax on shipping rates.
  • false - Taxes are not included in the subtotal. This value is the default.
Values are case sensitive.
Tax 1 Title The name of the first tax charged. For example, HST or VAT.
Tax 1 Price The amount (ISO 4217) of tax to be charged for the line items. For example, 1.50. When there is a value for this column, you must also include the Total Tax column.
Tax 1 Rate The rate (decimal) of tax to be charged for the line items. For example, .07 for a 7 percent tax rate.
Tax 2 Title The name of the second tax charged.
Tax 2 Price The amount (ISO 4217) of tax to be charged. When there is a value for this column, you must also include the Total Tax column.
Tax 2 Rate The rate of tax to be charged for the line items.
Tax 3 Title The name of the third tax charged.
Tax 3 Price The amount (ISO 4217) of tax to be charged for the line items. When there is a value for this column, you must also include the Total Tax column.
Tax 3 Rate The rate of tax to be charged for the line items.
Transaction Amount The amount (decimal) of money that the transaction was for. For example, 50.00. This column is required when you are doing a partial payment or partial refund.
Transaction Kind The transaction's type. This column is required when any of the transaction columns are included. Valid values:
  • authorization - The money that the customer has agreed to pay has been authorized, but it has not been captured. The authorization period can be between 7 and 30 days (depending on your payment service) while a store waits for a payment to be captured.
  • capture - A transfer of money that was reserved during the authorization.
  • sale - The authorization and capture of a payment performed in one single step.
  • void - The cancellation of a pending authorization or capture.
  • refund - The partial or full return of captured money to the customer.
Values are case sensitive.
Transaction Status The status of the transaction. Valid values:
  • success - The transaction was successfully completed by the payment gateway. This is the default value.
  • pending - The gateway has received the transaction information, but it has sent back a response that indicates that it needs more time to complete it.
  • failure - The gateway sent a response that the transaction was unsuccessful (for example, because the card was declined or the store didn't have the payment gateway setup properly).
  • error - A communication error occurred (for example, the response from the gateway wasn't received or the gateway didn't receive the request).
Values are case sensitive.
Transaction Processed At

The date and time (ISO 8601 format) when the transaction was originally performed in the other platform. This value appears on the order in your Shopify admin, and it's the date used in finance reports. The default value is the date and time when the order is imported.

If you received payment at the same time that the order was created, then the Transaction Processed At and Processed At values should be the same.

Transaction Gateway The name of the gateway the transaction was issued through. A list of gateways can be found on Shopify's payment gateways page.
Transaction Location ID The identifier of the location where the transaction was made. This ID needs to match a location ID that is set in your store. Values that do not match transaction location IDs in the store are not imported.
Transaction Source Name The origin of the transaction. Example values: web, pos, iphone, and android.
Shipping Line Code A reference to the shipping method. The default value is the Shipping line title.
Shipping Line Price The value of the shipping method. This column is required when the Shipping line title column is included.
Shipping Line Source The origin of the shipment.
Shipping Line Title The title of the shipping method. This column is required when the Shipping line price column is included.
Shipping Line Carrier Identifier The identifier of the carrier service that provided the shipping rate. A value is usually needed when a third-party carrier service is used.
Shipping Line Requested Fulfillment Service ID The identifier for the fulfillment service that requested the shipping method. A value is usually needed when the shipping method requires processing by a third-party fulfillment service.
Shipping Tax 1 Title The name of the tax charged to the shipping line item. For example, HST.
Shipping Tax 1 Rate The rate of tax (decimal) to be charged for the shipping line item. For example, 0.15 for a 15% (percent) shipping tax rate.
Shipping Tax Price The amount (ISO 4217 format) of tax to be charged for the shipping line item. When there is a value for this column, you must also include the Total Tax column. For example, 1.50.
Discount Code The discount code. If you include the Discount type column, then this column is required.
Discount Amount The value (in the store's currency) of the discount that was deducted from the order. If you include the Discount type column, then this column is required.
Discount Type

The type of discount. Valid values:

  1. fixed_amount - The discount code was for a specific amount. This is the default value.
  2. percentage - The discount code was for a percentage amount.
  3. shipping - The discount was offer was for free shipping as long as the shipping cost was less than the value set in amount. For example, if Discount amount is 30 and the shipping cost is $30, then the discount is $30. If the Discount amount is 30 and the shipping cost is $100, then there is no discount.
Values are case sensitive.
Metafield Namespace A container for a set of metafields. To import metafields, you need to include values in all 4 metafield columns (Metafield Namespace, Metafield Key, Metafield Value, and Metafield Value Type). Define a custom namespace for your metafields to distinguish them from namespaces used by apps and Shopify (including the default global). Maximum length: 20 characters.
Metafield Key The name of the metafield. Maximum length: 30 characters. This column is required if other metafield columns are included.
Metafield Value The information to be stored as metadata. This column is required if other metafield columns are included.
Metafield Value Type The metafield's information type. Valid values:
  • string
  • integer
  • json_string
Values are case sensitive. This column is required if other metafield columns are included.

File name

The name of your CSV file needs to include the word order (name of the object type that it contains). For example, myorders.csv. The file needs to be in UTF-8 format.

Addresses

The shipping address in an order becomes the customer's default address. When you import an order that has a customer associated with it, the Transporter app checks for the customer in your Shopify store:

  • If Transporter finds the customer, then the order is associated with the customer and the shipping address in the order is set as the customer's default address.
  • If Transporter doesn't find the customer, then the customer is added and the order is associated with them.

Multiple transactions

Additional transactions can be added to an order by creating separate rows for each transaction. The Order name needs to be included in each row to link the transactions to the order.

Order fulfillment status

An order's fulfillment status should be determined based on the fulfillment status of the line items that make up that order:

  • If all line items are unfulfilled, then the order fulfillment status should be left blank to indicate the order is unfulfilled.
  • If the line items have any combination of statuses (fulfilled or unfulfilled), then the order fulfillment status should be partial.
  • If all line items are fulfilled, then the order fulfillment status should be fulfilled.

Learn more

Ready to start selling with Shopify?

Try it free