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 customAttributescustomAttributes • [AttributeInput!]: A generic custom attribute using a key value pair.
Anchor to originalUnitPriceoriginalUnitPrice • Money: The custom line item price without any discounts applied in shop currency. This field is ignored when variantId is provided.
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 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.
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.

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?