EZ Importer: Shopify Order Fields Reference
Below is a list of fields (and their descriptions) that we support for the Order resource. For a detailed explanation of how to import data using any of these fields, search our documentation here.
Field ID | Description |
---|---|
order number |
Name. The customer's order name as represented by a number. This is the order number for the order you're importing. If duplicate order names are found in the csv we will import the duplicate order names as additional line items in the order. Order name must be unique. |
fulfillment_status |
Fulfillment Status. |
currency |
Currency. The three letter code (ISO 4217) for the currency used for the payment. |
taxes_included |
Taxes Included. States whether or not taxes are included in the order subtotal. Valid values are 'true' or 'false.' |
total_tax |
Taxes. The sum of all the taxes applied to the order (must be positive). |
tax_exempt |
Tax Exempt. Whether the order is tax exempt, if true taxes will not be applied to the order total. |
total_discounts |
Discount Amount. The total amount of the discounts to be applied to the price of the order. |
total_weight |
Total Weight. The sum of all the weights of the line items in the order, in grams. |
financial_status |
Financial Status. Valid values for Financial Status are as follows:
|
buyer_accepts_marketing |
Buyer Accepts Marketing. Indicates whether or not the person who placed the order would like to receive email updates from the shop. This is set when checking the 'I want to receive occasional emails about new products, promotions and other news' checkbox during checkout. Valid values are 'true' and 'false.' |
email |
Email. The customer's email address. Is required when a billing address is present. |
phone |
Phone. The unique phone number (E.164 format) for this customer. Attempting to assign the same phone number to multiple customers returns an error. The property can be set using different formats, but each format must represent a number that can be dialed from anywhere in the world. At this time Shopify allows the following formats when importing a customer phone number with your order:
|
note |
Notes. The text of an optional note that a shop owner can attach to the order. |
po_number |
PO Number. The purchase order number associated to this order. |
referring_site |
Referring Site. The website that the customer clicked on to come to the shop. |
tags |
Tags. Tags are additional short descriptors, commonly used for filtering and searching, formatted as a string of comma-separated values. For example, if an order has three tags: tag1, tag2, tag3. Each individual tag is limited to 40 characters in length. |
note_attributes |
Note Attributes. Extra information that is added to the order. Each array entry must contain a hash with 'name' and 'value' keys. An array of json documents are valid as well as the Shopify export format. |
processed_at |
Created at. The date and time when the order was processed. We recommend using ISO 8601 format when possible. This value can be set to dates in the past when importing from other systems. If no value is provided, it will be auto-generated based on the current date and time in Shopify. |
closed_at |
Cancelled at. The date and time when the order was closed. We recommend using ISO 8601 format when possible. If the order was not closed, do not select this field. |
location_id |
Location Id. The ID of the physical location where the order was processed. This has NO effect on the location of your fulfillments. |
customer.email |
Email. The customer's email address. |
customer.first_name |
Customer First Name. The customer's first name. |
customer.last_name |
Customer Last Name. The customer's last name. |
customer.phone |
Phone. The unique phone number (E.164 format) for this customer. Attempting to assign the same phone number to multiple customers returns an error. The property can be set using different formats, but each format must represent a number that can be dialed from anywhere in the world. At this time Shopify allows the following formats when importing a customer phone number with your order:
|
customer.note |
Customer Note. Extra information about the customer. |
customer.tax_exempt |
Customer Tax Exempt. Whether the customer is exempt from paying taxes on their order. If true, then taxes won't be applied to an order at checkout. If false, then taxes will be applied at checkout. |
billing_address.first_name |
Billing First Name. The first name of the person associated with the payment method. |
billing_address.last_name |
Billing Last Name. The last name of the person associated with the payment method. |
billing_address.address1 |
Billing Address1. The street address of the billing address. |
billing_address.city |
Billing City. The city of the billing address. |
billing_address.zip |
Billing Zip. The zip or postal code of the billing address. |
billing_address.country |
Billing Country. The name of the country of the billing address. |
billing_address.province |
Billing Province. The name of the state or province of the billing address. |
billing_address.name |
Billing Name. The full name of the person associated with the payment method. |
billing_address.address2 |
Billing Address2. An optional additional field for the street address of the billing address. |
billing_address.company |
Billing Company. The company of the person associated with the billing address. |
billing_address.phone |
Billing Phone. The phone number at the billing address. |
billing_address.province_code |
Billing Province Code. The two-letter abbreviation of the state or province of the billing address. |
billing_address.country_code |
Billing Country Code. The two-letter code (ISO 3166-1 alpha-2 two-letter country code) for the country of the billing address.) |
billing_address.default |
Billing Default. Default billing address. Valid values are true or false. |
shipping_address.first_name |
Shipping First Name. The first name of the person associated with the payment method. |
shipping_address.last_name |
Shipping Last Name. The last name of the person associated with the payment method. |
shipping_address.address1 |
Shipping Address1. The street address of the shipping address. |
shipping_address.city |
Shipping City. The city of the shipping address. |
shipping_address.zip |
Shipping Zip. The zip or postal code of the shipping address. |
shipping_address.country |
Shipping Country. The name of the country of the shipping address. |
shipping_address.province |
Shipping Province. The name of the state or province of the shipping address. |
shipping_address.name |
Shipping Name. The full name of the person associated with the payment method. |
shipping_address.address2 |
Shipping Address2. An optional additional field for the street address of the shipping address. |
shipping_address.company |
Shipping Company. The company of the person associated with the shipping address. |
shipping_address.latitude |
Shipping Latitude. The latitude of the shipping address. |
shipping_address.longitude |
Shipping Longitude. The longitude of the shipping address. |
shipping_address.phone |
Shipping Phone. The phone number at the shipping address. |
shipping_address.country_code |
Shipping Country Code. The two-letter code for the country of the shipping address. |
shipping_address.province_code |
Shipping Province Code. The two-letter abbreviation of the state or province of the shipping address. |
line_items.title |
Lineitem name. The title of the product. |
line_items.price |
Lineitem price. The price of the item before discounts have been applied. |
line_items.quantity |
Lineitem quantity. The number of products that were purchased. |
line_items.fulfillment_status |
Lineitem fulfillment status. How far along an order is in terms line items fulfilled. Valid values are: fulfilled, unfulfilled or partial. |
line_items.fulfillable_quantity |
Lineitem Fulfillable Quantity. The amount available to fulfill. This is the quantity - max(refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity - open_fulfilled_quantity.) |
line_items.sku |
Lineitem sku. The item's SKU (stock keeping unit). |
line_items.grams |
Lineitem Grams. The weight of the item in grams. |
line_items.product_id |
Lineitem Product ID. The unique numeric identifier for the product in the fulfillment. |
line_items.requires_shipping |
Lineitem requires shipping. States whether or not the fulfillment requires shipping. Values are: true or false. |
line_items.variant_id |
Lineitem Variant ID. The id of the product variant. |
line_items.variant_title |
Lineitem Variant Title. The title of the product variant. |
line_items.vendor |
Vendor. The name of the supplier of the item. |
line_items.gift_card |
Lineitem Gift Card. States whether or not the line_item is a gift card. If so, the item is not taxed or considered for shipping charges. |
line_items.taxable |
Lineitem taxable. States whether or not the product was taxable. Values are: true or false. |
line_items.total_discount |
Lineitem discount. The total discount amount applied to this line item. This value is not subtracted in the line item price. |
line_items.properties |
Lineitem Properties. An array of custom information for an item that has been added to the cart. Often used to provide product customization options. Each array entry must contain a hash with 'name' and 'value' keys. An array of json documents are valid as well as the Shopify export format. |
line_items.barcode |
Lineitem Barcode. The item's Barcode (ISBN, UPC, GTIN, etc.). Field is not sent to Shopify, used in coordination with Link By Barcode feature. |
shipping_lines.price |
Shipping. The price of this shipping method. |
shipping_lines.title |
Shipping Method. The title of the shipping method. |
shipping_lines.code |
Shipping Method Code. A reference to the shipping method. |
shipping_lines.source |
Shipping Method Source. The source of the shipping method. |
discount_codes.amount |
Discount Amount. The amount of the discount. The type field determines the unit of this amount. |
discount_codes.code |
Discount Code. The discount code. |
discount_codes.type |
Discount Type. The type of discount. Valid values are:
|
transactions.amount |
Total. The amount of money that the transaction was for. |
transactions.gateway |
Payment Method. The name of the gateway the transaction was issued through. A list of gateways can be found on Shopifys Payment Gateway page. |
transactions.status |
Transaction Status. The status of the transaction. Valid values are:
|
transactions.kind |
Transaction Kind. The kind of transaction:
|
transactions.currency |
Transaction Currency. The three letter code (ISO 4217) for the currency used for the payment. |
transactions.processed_at |
Paid at. The date and time (ISO 8601 format) when a transaction was processed. This value is the date that's used in the analytic reports. By default, it matches the created_at value. If you're importing transactions from an app or another platform, then you can set processed_at to a date and time in the past to match when the original transaction was processed. |
tax_lines.price |
Tax 1 Value. The amount of tax to be charged. |
tax_lines.rate |
Tax 1 Rate. The rate of tax to be applied |
tax_lines.title |
Tax 1 Name. The name of the tax |
fulfillment_orders.assigned_location_id |
Location Id. The ID of the location that has been assigned to do the work. |
fulfillments.tracking_company |
Tracking Company. The name of the tracking company. When creating a fulfillment for a supported carrier, send the tracking_company exactly as listed in our documentation. If the tracking company doesn't match one of the supported entries, then the shipping status might not be updated properly during the fulfillment process. If you do not know the tracking company or if the tracking company is not supported by Shopify set it to Other. |
fulfillments.tracking_numbers |
Tracking Number. Tracking numbers, provided by the shipping company. It is highly recommended that you send the tracking company and/or the tracking URL as well. If neither one of these is sent, then the tracking company will be determined automatically. This can result in an invalid tracking URL. When accounts are enabled, it is also displayed in the customer's order history. |
fulfillments.tracking_urls |
Tracking URL. The URLs of tracking pages for the fulfillment. If left blank, Shopify will automatically generate the tracking url based on your tracking number and company. |
App: EZ Importer
Tags: shopify, field reference, shopify fields