Draft orders

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

Field

Description

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.

The billing address of the customer.

Field

Description

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.

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

Field

Description

Field

Description

Key

Key or name of the attribute.

Value

Value of the attribute.

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

Field

Description

Field

Description

Customer ID

Globally unique ID.

List of the line items in the draft order.

Field

Description

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.