Page Comparison

Expand

title	Draft orders

List of saved draft orders. Draft order is an order that a merchant creates on behalf of a customer.

Field	Description
Completed at	Date and time when the draft order converted to a new order, and the draft order's status changed to Completed.
Created at	Date and time when the draft order was created in Shopify.
Email	Email address of the customer, which is used to send notifications to.
Has timeline comment	Whether the merchant has added timeline comments to the draft order.
ID	Globally unique ID.
Invoice URL	Link to the checkout, which is sent to your customer in the invoice email.
Invoice sent at	Date and time when the invoice was last emailed to the customer.
Legacy resource ID	The ID of the corresponding resource in the REST Admin API.
Name	Unique identifier for the draft order, which is unique within the store. For example, #D1223.
Note	Text from an optional note attached to the draft order.
Ready	Whether or not the Draft Order is ready and can be completed. Draft Orders may have asynchronous operations that can take time to finish.
Status	Status of the draft order.
Subtotal price	Subtotal of the line items and their discounts (does not contain shipping charges or shipping discounts, or taxes).
Tags	A comma separated list of tags associated with the draft order.
Tax exempt	Whether the draft order is tax exempt.
Taxes included	Whether the line item prices include taxes.
Total price	Total amount of the draft order (includes taxes, shipping charges, and discounts).
Total shipping price	Total shipping charge for the draft order.
Total tax	Total amount of taxes for the draft order.
Total weight	Total weight (grams) of the draft order.
Updated at	Date and time when the draft order was last changed.

Expand

title	Draft orders / Billing address

The billing address of the customer.

Field	Description
City	The name of the city, district, village, or town.
Company	The name of the customer's company or organization.
Country	The name of the country.
Country code	The two-letter code for the country of the address. For example, US.
First line	The first line of the address. Typically the street address or PO Box number.
First name	The first name of the customer.
Formatted	A formatted version of the address, customized by the provided arguments.
Formatted area	A comma-separated list of the values for city, province, and country.
ID	Globally unique ID.
Last name	The last name of the customer.
Latitude	The latitude coordinate of the customer address.
Longitude	The longitude coordinate of the customer address.
Name	The full name of the customer, based on firstName and lastName.
Phone	A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.
Province	The region of the address, such as the province, state, or district.
Province code	The two-letter code for the region. For example, ON.
Second line	The second line of the address. Typically the number of the apartment, suite, or unit.
Zip	The zip or postal code of the address.

Expand

title	Draft orders / Custom attributes

Custom information added to the draft order on behalf of your customer.

Field	Description
Key	Key or name of the attribute.
Value	Value of the attribute.

Expand

title	Draft orders / Customer

Customer who will be sent an invoice for the draft order, if there is one.

Field	Description
Customer ID	Globally unique ID.

Expand

title	Draft orders / Line items

List of the line items in the draft order.

Field	Description
Custom	Whether this is a product variant line item, or a custom line item. If set to true indicates a custom line item. If set to false indicates a product variant line item.
Discounted total	Line item price after discounts are applied.
Discounted unit price	The discountedTotal divided by quantity, resulting in the value of the discount per unit.
Is gift card	Whether the line item represents the purchase of a gift card.
Name	Name of the product.
Original total	Total price (without discounts) of the line item, based on the original unit price of the variant x quantity.
Original unit price	Variant price without any discounts applied.
Quantity	Number of variant items requested in the draft order.
Requires shipping	Whether physical shipping is required for the variant
SKU	Variant SKU number.
Taxable	Whether the variant is taxable.
Title	Title of the product or variant (this field only applies to custom line items).
Total discount	Total value of the discount applied to the line item.
Variant title	Name of the variant.
Vendor	Name of the vendor who made the variant.

Expand

title	Draft orders / Line items / Product

The product corresponding to the line item’s product variant.

Field	Description
Product ID	Globally unique ID.

Expand

title	Draft orders / Line items / Tax lines

A list of tax line objects, each of which details the total taxes applicable to the line item.

Field	Description
Price	The amount of tax to be charged.
Rate	The tax rate to be applied.
Rate percentage	The percentage of the price that the tax rate represents.
Title	The name of the tax.

Expand

title	Draft orders / Line items / Variant

Associated variant for the line item.

Field	Description
Product variant ID	Globally unique ID.

Expand

title	Draft orders / Metafields

A list of metafields that belong to the resource.

Field	Description
Description	The description of a metafield.
Key	The key name for a metafield.
Legacy resource ID	The ID of the corresponding resource in the REST Admin API.
Metafield ID	Globally unique ID.
Namespace	The namespace for a metafield.
Owner type	Owner type of a metafield visible to the Storefront API.
Type	The type of data that the metafield stores in the value field.
Value	The value of a metafield.

Expand

title	Draft orders / Order

Order that was created from this draft order.

Field	Description
Order ID	Globally unique ID.

Expand

title	Draft orders / Shipping address

The shipping address of the customer.

Field	Description
City	The name of the city, district, village, or town.
Company	The name of the customer's company or organization.
Country	The name of the country.
Country code	The two-letter code for the country of the address. For example, US.
First line	The first line of the address. Typically the street address or PO Box number.
First name	The first name of the customer.
Formatted	A formatted version of the address, customized by the provided arguments.
Formatted area	A comma-separated list of the values for city, province, and country.
ID	Globally unique ID.
Last name	The last name of the customer.
Latitude	The latitude coordinate of the customer address.
Longitude	The longitude coordinate of the customer address.
Name	The full name of the customer, based on firstName and lastName.
Phone	A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.
Province	The region of the address, such as the province, state, or district.
Province code	The two-letter code for the region. For example, ON.
Second line	The second line of the address. Typically the number of the apartment, suite, or unit.
Zip	The zip or postal code of the address.

Expand

title	Draft orders / Shipping line

Line item that contains the shipping costs.

Field	Description
Carrier identifier	A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
Code	A reference to the shipping method.
Custom	Whether the shipping line is custom or not.
Delivery category	The general classification of the delivery method.
ID	Globally unique ID.
Phone	The phone number at the shipping address.
Shipping rate handle	A unique identifier for the shipping rate. The format can change without notice and is not meant to be shown to users.
Source	Returns the rate source for the shipping line.
Title	Returns the title of the shipping line.

Expand

title	Draft orders / Shipping line / Discounted price set

The pre-tax shipping price with discounts applied.

Field	Description
Presentment money amount	Amount in presentment currency.
Presentment money currency code	Currency code of the amount in presentment currency.
Shop money amount	Amount in shop currency.
Shop money currency code	Currency code of the amount in shop currency.

Expand

title	Draft orders / Shipping line / Original price set

The pre-tax shipping price without any discounts applied.

Field	Description
Presentment money amount	Amount in presentment currency.
Presentment money currency code	Currency code of the amount in presentment currency.
Shop money amount	Amount in shop currency.
Shop money currency code	Currency code of the amount in shop currency.

Expand

title	Draft orders / Tax lines

Total amount of taxes charged for each line item and shipping line.

Field	Description
Price	The amount of tax to be charged.
Rate	The tax rate to be applied.
Rate percentage	The percentage of the price that the tax rate represents.
Title	The name of the tax.

Versions Compared

Old Version 1

New Version Current

Key