Choose a version:

DraftOrderPlatformDiscountAllocationTarget

union

Requires read_draft_orders access scope.

The element of the draft being discounted.

Anchor to Possible typesPossible types

CalculatedDraftOrderLineItem

•

OBJECT

The calculated line item for a draft order.

appliedDiscount• DraftOrderAppliedDiscount: The custom applied discount.
approximateDiscountedUnitPriceSet• MoneyBag! non-null: The discountedTotal divided by quantity, equal to the average value of the line item price per unit after discounts are applied. This value doesn't include discounts applied to the entire draft order.
bundleComponents• [CalculatedDraftOrderLineItem!]! non-null: The bundle components of the draft order line item.
custom• Boolean! non-null: Whether the line item is custom (true) or contains a product variant (false).
customAttributes• [Attribute!]! non-null: A list of attributes that represent custom features or special requests.
customAttributesV2• [TypedAttribute!]! non-null: The list of additional information (metafields) with the associated types.
discountedTotal• MoneyV2! non-null: The total price with discounts applied.
discountedTotalSet• MoneyBag! non-null: The total price with discounts applied.
fulfillmentService• FulfillmentService: Name of the service provider who fulfilled the order.

Valid values are either manual or the name of the provider. For example, amazon, shipwire.

Deleted fulfillment services will return null.
image• Image: The image associated with the draft order line item.
isGiftCard• Boolean! non-null: Whether the line item represents the purchase of a gift card.
name• String! non-null: The name of the product.
originalTotal• MoneyV2! non-null: The total price, excluding discounts, equal to the original unit price multiplied by quantity.
originalTotalSet• MoneyBag! non-null: The total price excluding discounts, equal to the original unit price multiplied by quantity.
originalUnitPrice• MoneyV2! non-null: The line item price without any discounts applied.
originalUnitPriceSet• MoneyBag! non-null: The price without any discounts applied.
originalUnitPriceWithCurrency• MoneyV2: The original custom line item input price.
product• Product: The product for the line item.
quantity• Int! non-null: The quantity of items. For a bundle item, this is the quantity of bundles, not the quantity of items contained in the bundles themselves.
requiresShipping• Boolean! non-null: Whether physical shipping is required for the variant.
sku• String: The SKU number of the product variant.
taxable• Boolean! non-null: Whether the variant is taxable.
title• String! non-null: The title of the product or variant. This field only applies to custom line items.
totalDiscount• MoneyV2! non-null: The total value of the discount.
totalDiscountSet• MoneyBag! non-null: The total discount amount.
uuid• String! non-null: 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.
variant• ProductVariant: The product variant for the line item.
variantTitle• String: The name of the variant.
vendor• String: The name of the vendor who created the product variant.
weight• Weight: The weight unit and value.
discountedUnitPrice• MoneyV2! non-null: The unit price with discounts applied.
discountedUnitPriceSet• MoneyBag! non-null: The unit price with discounts applied.

DraftOrderLineItem

•

OBJECT

The line item for a draft order.

appliedDiscount• DraftOrderAppliedDiscount: The custom applied discount.
approximateDiscountedUnitPriceSet• MoneyBag! non-null: The discountedTotal divided by quantity, equal to the average value of the line item price per unit after discounts are applied. This value doesn't include discounts applied to the entire draft order.
bundleComponents• [DraftOrderLineItem!]! non-null: The list of bundle components if applicable.
custom• Boolean! non-null: Whether the line item is custom (true) or contains a product variant (false).
customAttributes• [Attribute!]! non-null: A list of attributes that represent custom features or special requests.
customAttributesV2• [TypedAttribute!]! non-null: The list of additional information (metafields) with the associated types.
discountedTotalSet• MoneyBag! non-null: The total price with discounts applied.
fulfillmentService• FulfillmentService: Name of the service provider who fulfilled the order.

Valid values are either manual or the name of the provider. For example, amazon, shipwire.

Deleted fulfillment services will return null.
id• ID! non-null: A globally-unique ID.
image• Image: The image of the product variant.
isGiftCard• Boolean! non-null: Whether the line item represents the purchase of a gift card.
name• String! non-null: The name of the product.
originalTotalSet• MoneyBag! non-null: The total price excluding discounts, equal to the original unit price multiplied by quantity.
originalUnitPriceSet• MoneyBag! non-null: The price without any discounts applied.
originalUnitPriceWithCurrency• MoneyV2: The original custom line item input price.
product• Product: The product for the line item.
quantity• Int! non-null: The quantity of items. For a bundle item, this is the quantity of bundles, not the quantity of items contained in the bundles themselves.
requiresShipping• Boolean! non-null: Whether physical shipping is required for the variant.
sku• String: The SKU number of the product variant.
taxable• Boolean! non-null: Whether the variant is taxable.
taxLines• [TaxLine!]! non-null: A list of tax lines.
title• String! non-null: The title of the product or variant. This field only applies to custom line items.
totalDiscountSet• MoneyBag! non-null: The total discount amount.
uuid• String! non-null: 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.
variant• ProductVariant: The product variant for the line item.
variantTitle• String: The name of the variant.
vendor• String: The name of the vendor who created the product variant.
weight• Weight: The weight unit and value.
discountedTotal• Money! non-null: The line item price, in shop currency, after discounts are applied.
discountedUnitPrice• Money! non-null: The discountedTotal divided by quantity, equal to the value of the discount per unit in the shop currency.
discountedUnitPriceSet• MoneyBag! non-null: The unit price with discounts applied.
grams• Int: The weight of the line item in grams.
originalTotal• Money! non-null: The total price, in shop currency, excluding discounts, equal to the original unit price multiplied by quantity.
originalUnitPrice• Money! non-null: The price, in shop currency, without any discounts applied.
totalDiscount• Money! non-null: The total discount applied in shop currency.

ShippingLine

•

OBJECT

Represents the shipping details that the customer chose for their order.

carrierIdentifier• String: A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
code• String: A reference to the shipping method.
custom• Boolean! non-null: Whether the shipping line is custom or not.
deliveryCategory• String: The general classification of the delivery method.
discountAllocations• [DiscountAllocation!]! non-null: The discounts that have been allocated to the shipping line.
discountedPriceSet• MoneyBag! non-null: The shipping price after applying discounts. If the parent order.taxesIncluded field is true, then this price includes taxes. If not, it's the pre-tax price. As of API version 2024-07, this will be calculated including cart level discounts, such as the free shipping discount.
id• ID: A globally-unique ID.
isRemoved• Boolean! non-null: Whether the shipping line has been removed.
originalPriceSet• MoneyBag! non-null: The pre-tax shipping price without any discounts applied.
phone• String: The phone number at the shipping address.
shippingRateHandle• String: A unique identifier for the shipping rate. The format can change without notice and isn't meant to be shown to users.
source• String: Returns the rate source for the shipping line.
taxLines• [TaxLine!]! non-null: The TaxLine objects connected to this shipping line.
title• String! non-null: Returns the title of the shipping line.
discountedPrice• MoneyV2! non-null: The pre-tax shipping price with discounts applied. As of API version 2024-07, this will be calculated including cart level discounts, such as the free shipping discount.
originalPrice• MoneyV2! non-null: The pre-tax shipping price without any discounts applied.
price• Money! non-null: Returns the price of the shipping line.
requestedFulfillmentService• FulfillmentService: The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service.

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to DraftOrderPlatformDiscountAllocation.target DraftOrderPlatformDiscountAllocation.target • OBJECT: The element of the draft being discounted.

Was this section helpful?