Home > @infiniteobjects/shopify-data-manager > AdminTypes > DraftOrderInput
The input fields used to create or update a draft order.
Signature:
export interface DraftOrderInput
| Property | Modifiers | Type | Description |
|---|---|---|---|
| appliedDiscount? | InputMaybe<DraftOrderAppliedDiscountInput> | (Optional) The discount that will be applied to the draft order. A draft order line item can have one discount. A draft order can also have one order-level discount. | |
| billingAddress? | InputMaybe<MailingAddressInput> | (Optional) The mailing address associated with the payment method. | |
| customAttributes? | InputMaybe<Array<AttributeInput>> | (Optional) Extra information added to the customer. | |
| email? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The customer’s email address. | |
| lineItems? | InputMaybe<Array<DraftOrderLineItemInput>> | (Optional) Product variant line item or custom line item associated to the draft order. Each draft order must include at least one line item. | |
| localizationExtensions? | InputMaybe<Array<LocalizationExtensionInput>> | (Optional) The localization extensions attached to the draft order. For example, Tax IDs. | |
| marketRegionCountryCode? | InputMaybe<CountryCode | `${CountryCode}`> | (Optional) The selected market region country code for the draft order. | |
| metafields? | InputMaybe<Array<MetafieldInput>> | (Optional) Metafields attached to the draft order. | |
| note? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The text of an optional note that a shop owner can attach to the draft order. | |
| paymentTerms? | InputMaybe<PaymentTermsInput> | (Optional) The fields used to create payment terms. | |
| phone? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The customer’s phone number. | |
| poNumber? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The purchase order number. | |
| presentmentCurrencyCode? | InputMaybe<CurrencyCode | `${CurrencyCode}`> | (Optional) The payment currency of the customer for this draft order. | |
| purchasingEntity? | InputMaybe<PurchasingEntityInput> | (Optional) The purchasing entity for this draft order. | |
| reserveInventoryUntil? | InputMaybe<Scalars[‘DateTime’][‘input’]> | (Optional) Time after which inventory will automatically be restocked. | |
| shippingAddress? | InputMaybe<MailingAddressInput> | (Optional) The mailing address to where the order will be shipped. | |
| shippingLine? | InputMaybe<ShippingLineInput> | (Optional) A shipping line object, which details the shipping method used. | |
| sourceName? | InputMaybe<Scalars[‘String’][‘input’]> | (Optional) The source of the checkout. To use this field for sales attribution, you must register the channels that your app is managing. You can register the channels that your app is managing by completing [this Google Form](https://docs.google.com/forms/d/e/1FAIpQLScmVTZRQNjOJ7RD738mL1lGeFjqKVe_FM2tO9xsm21QEo5Ozg/viewform?usp=sf_link). After you’ve submitted your request, you need to wait for your request to be processed by Shopify. You can find a list of your channels in the Partner Dashboard, in your app’s Marketplace extension. You need to specify the handle as the source_name value in your request. The handle is the channel that the order was placed from. |
|
| tags? | InputMaybe<Array<Scalars[‘String’][‘input’]>> | (Optional) A comma separated list of tags that have been added to the draft order. | |
| taxExempt? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) Whether or not taxes are exempt for the draft order. If false, then Shopify will refer to the taxable field for each line item. If a customer is applied to the draft order, then Shopify will use the customer’s tax exempt field instead. | |
| useCustomerDefaultAddress? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) Sent as part of a draft order object to load customer shipping information. | |
| visibleToCustomer? | InputMaybe<Scalars[‘Boolean’][‘input’]> | (Optional) Whether the draft order will be visible to the customer on the self-serve portal. |