DraftOrderLineItemInput

input_object

The input fields for a line item included in a draft order.

Anchor to FieldsFields

Anchor to appliedDiscountappliedDiscount • DraftOrderAppliedDiscountInput: The custom discount to be applied.
Anchor to bundleComponentsbundleComponents • [BundlesDraftOrderBundleLineItemComponentInput!]: The bundle components when the line item is a bundle.
Anchor to customAttributescustomAttributes • [AttributeInput!]: A generic custom attribute using a key value pair.
Anchor to generatePriceOverridegeneratePriceOverride • Boolean: If the line item doesn't already have a price override input, setting generatePriceOverride to true will create a price override from the current price.
Anchor to originalUnitPriceWithCurrencyoriginalUnitPriceWithCurrency • MoneyInput: The price in presentment currency, without any discounts applied, for a custom line item. If this value is provided, original_unit_price will be ignored. This field is ignored when variantId is provided. Note: All presentment currencies for a single draft should be the same and match the presentment currency of the draft order.
Anchor to priceOverridepriceOverride • MoneyInput: The price override for the line item. Should be set in presentment currency.

This price will be used in place of the product variant's catalog price in this draft order.

If the override's presentment currency doesn't match the draft order's presentment currency, it will be converted over to match the draft order's presentment currency. This will occur if the input is defined in a differing currency, or if some other event causes the draft order's currency to change.

Price overrides can't be applied to bundle components. If this line item becomes part of a bundle the price override will be removed. In the case of a cart transform, this may mean that a price override is applied to this line item earlier in its lifecycle, and is removed later when the transform occurs.
Anchor to quantityquantity • Int!non-null: The line item quantity.
Anchor to requiresShippingrequiresShipping • Boolean: Whether physical shipping is required for a custom line item. This field is ignored when variantId is provided.
Anchor to skusku • String: The SKU number for custom line items only. This field is ignored when variantId is provided.
Anchor to taxabletaxable • Boolean: Whether the custom line item is taxable. This field is ignored when variantId is provided.
Anchor to titletitle • String: Title of the line item. This field is ignored when variantId is provided.
Anchor to uuiduuid • String: The UUID of the draft order line item. Must be unique and consistent across requests. This field is mandatory in order to manipulate drafts with bundles.
Anchor to variantIdvariantId • ID: The ID of the product variant corresponding to the line item. Must be null for custom line items, otherwise required.
Anchor to weightweight • WeightInput: The weight unit and value inputs for custom line items only. This field is ignored when variantId is provided.

Show

deprecated fields Deprecated

Anchor to gramsgrams • IntDeprecated: The weight in grams for custom line items. This field is ignored when variantId is provided. weight should be used instead, allowing different units to be used.
Anchor to originalUnitPriceoriginalUnitPrice • MoneyDeprecated: The custom line item price without any discounts applied in shop currency. This field is ignored when variantId is provided. originalUnitPriceWithCurrency should be used instead, where currency can be specified.

Was this section helpful?

Anchor to Input objects using this inputInput objects using this input

Anchor to DraftOrderInput.lineItems DraftOrderInput.lineItems • INPUT OBJECT: The list of product variant or custom line item. Each draft order must include at least one line item.

NOTE: Draft orders don't currently support subscriptions.

Was this section helpful?