EZ Importer: Shopify Draft Order Fields Reference
Below is a list of fields (and their descriptions) that we support for the Draft Order resource. Read our documentation to learn how to use the below fields to import your Draft Orders.
Field ID | Description |
---|---|
internal_draft_order_id |
Internal Draft Order Id. The Internal Draft Order ID is used by EZ Importer to match line items with their corresponding draft orders in the file you upload. This ID is for internal use only and is not sent to Shopify. It should be unique per order. |
note |
Note. The text of an optional note that a shop owner can attach to the order. |
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. |
email |
Email. The customer's email address. Is required when a billing address is present. |
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. |
tax_exempt |
Tax Exempt. Whether the order is tax exempt, if true taxes will not be applied to the order total. |
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. |
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.) |
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.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.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.applied_discount.title |
Lineitem Applied Discount Title. |
line_items.applied_discount.description |
Lineitem Applied Discount Description. |
line_items.applied_discount.value |
Lineitem Applied Discount Value. |
line_items.applied_discount.value_type |
Lineitem Applied Discount Value Type. |
line_items.applied_discount.amount |
Lineitem Applied Discount Amount. |
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_line.price |
Shipping. The price of the shipping method. Required for custom shipping lines. |
shipping_line.title |
Shipping Method. The title of the shipping method. Required for custom shipping lines. (maximum: 255 characters) |
shipping_line.handle |
Shipping Handle. The handle of the shipping rate which was selected and applied. Required for regular shipping lines. |
shipping_line.custom |
Shopify Line Custom. Whether this is a regular shipping line or custom shipping line. |
applied_discount.title |
Applied Discount Title. Title of the discount. |
applied_discount.description |
Applied Discount Description. Reason for the discount. |
applied_discount.value |
Applied Discount Value. The value of the discount. If the type of discount is fixed_amount, then it corresponds to a fixed dollar amount. If the type is percentage, then it corresponds to percentage |
applied_discount.value_type |
Applied Discount Value Type. The type of discount. Valid values: percentage, fixed_amount. |
applied_discount.amount |
Applied Discount Amount. The applied amount of the discount, based on the setting of value_type. |
App: EZ Importer
Tags: shopify, field reference, shopify fields