DraftOrders

Contains information on draft orders created prior to checkout, including customer, billing, and fulfillment details.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		A unique numeric identifier for the draft order.
CustomerId	Long	False	Customers.Id	A unique numeric identifier for the customer associated with the draft order.
Currency	String	False		The ISO 4217 three-letter currency code used for the order.
Email	String	False		The customer's email address used for this draft order.
Name	String	True		The display name of the draft order, typically shown as an order number.
TotalPrice	Decimal	True		The total cost of the draft order, including item prices, taxes, and discounts.
SubtotalPrice	Decimal	True		The total price of all items in the draft order before taxes and shipping.
TotalTax	Decimal	False		The total amount of taxes applied to the draft order.
TaxesIncluded	Bool	False		Indicates whether taxes are included in the subtotal price.
InvoiceSentAt	Datetime	True		The date and time when the draft order invoice was emailed to the customer. Available only for draft orders.
Note	String	False		An optional note that a merchant can attach to the draft order.
Tags	String	False		A comma-separated list of tags associated with the draft order.
InvoiceUrl	String	True		The URL of the invoice associated with the draft order. Available only for draft orders.
TaxExempt	Bool	True		Indicates whether the draft order is exempt from taxes.
Status	String	True		The current status of the draft order. Valid values: 'open' (active), 'invoice_sent' (invoice sent to customer), or 'completed' (finalized order). Defaults to 'open'.
LineAggregate	String	False		A JSON aggregate containing all line items associated with the draft order.
BillingAddressFirstName	String	False		The first name of the person listed on the billing address.
BillingAddressLastName	String	False		The last name of the person listed on the billing address.
BillingAddressAddress1	String	False		The first line of the billing street address.
BillingAddressAddress2	String	False		The second line of the billing street address, such as an apartment or suite number.
BillingAddressPhone	String	False		The phone number associated with the billing address.
BillingAddressCity	String	False		The city of the billing address.
BillingAddressCompany	String	False		The company name associated with the billing address.
BillingAddressZip	String	False		The postal or ZIP code of the billing address.
BillingAddressProvince	String	False		The state or province of the billing address.
BillingAddressCountry	String	False		The country of the billing address.
BillingAddressLatitude	Double	False		The latitude coordinate of the billing address.
BillingAddressLongitude	Double	False		The longitude coordinate of the billing address.
BillingAddressName	String	False		The full name associated with the billing address.
BillingAddressCountryCode	String	False		The two-letter ISO country code for the billing address.
BillingAddressProvinceCode	String	False		The two-letter abbreviation for the state or province of the billing address.
BillingAddressDefault	Bool	False		Indicates whether this is the customer's default billing address.
ShippingAddressFirstName	String	False		The first name of the person listed on the shipping address.
ShippingAddressLastName	String	False		The last name of the person listed on the shipping address.
ShippingAddressAddress1	String	False		The first line of the shipping street address.
ShippingAddressAddress2	String	False		The second line of the shipping street address, such as an apartment or suite number.
ShippingAddressPhone	String	False		The phone number associated with the shipping address.
ShippingAddressCity	String	False		The city of the shipping address.
ShippingAddressCompany	String	False		The company name associated with the shipping address.
ShippingAddressZip	String	False		The postal or ZIP code of the shipping address.
ShippingAddressProvince	String	False		The state or province of the shipping address.
ShippingAddressCountry	String	False		The country of the shipping address.
ShippingAddressLatitude	Double	False		The latitude coordinate of the shipping address.
ShippingAddressLongitude	Double	False		The longitude coordinate of the shipping address.
ShippingAddressName	String	False		The full name associated with the shipping address.
ShippingAddressCountryCode	String	False		The two-letter ISO country code for the shipping address.
ShippingAddressProvinceCode	String	False		The two-letter abbreviation for the state or province of the shipping address.
ShippingAddressDefault	Bool	False		Indicates whether this is the customer's default shipping address.
AppliedDiscountTitle	String	False		The title of the discount applied to the draft order.
AppliedDiscountDescription	String	False		A description of the discount applied to the draft order.
AppliedDiscountValue	Decimal	False		The value of the discount applied to the draft order.
AppliedDiscountValueType	String	False		The type of discount value, such as 'fixed_amount' or 'percentage'.
AppliedDiscountAmount	Decimal	False		The monetary amount of the discount applied to the draft order.
CreatedAt	Datetime	True		The date and time when the draft order was created.
UpdatedAt	Datetime	True		The date and time when the draft order was last updated.
CompletedAt	Datetime	True		The date and time when the draft order was completed.

Pseudo-Columns

疑似カラムは、明示的にリストされているタイプのステートメントでのみ使用できるフィールドです。これらは標準的なカラムではなく、特定の操作のための追加機能を提供するものです。


Name	Type	Description
UseCustomerDefaultAddress	Bool	Optional flag that, if true, automatically loads the customer's default shipping address into the draft order.

Code Assist MCP for Shopify

DraftOrders

Columns

Pseudo-Columns