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.

Anchor to appliedDiscountappliedDiscount •DraftOrderAppliedDiscount: The custom applied discount.
Anchor to approximateDiscountedUnitPriceSetapproximateDiscountedUnitPriceSet •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.
Anchor to componentscomponents •[CalculatedDraftOrderLineItem!]! non-null: The components of the draft order line item.
Anchor to customcustom •Boolean! non-null: Whether the line item is custom (true) or contains a product variant (false).
Anchor to customAttributescustomAttributes •[Attribute!]! non-null: A list of attributes that represent custom features or special requests.
Anchor to customAttributesV2customAttributesV2 •[TypedAttribute!]! non-null: The list of additional information (metafields) with the associated types.
Anchor to discountedTotaldiscountedTotal •MoneyV2! non-null: The total price with discounts applied.
Anchor to discountedTotalSetdiscountedTotalSet •MoneyBag! non-null: The total price with discounts applied.
Anchor to fulfillmentServicefulfillmentService •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.
Anchor to imageimage •Image: The image associated with the draft order line item.
Anchor to isGiftCardisGiftCard •Boolean! non-null: Whether the line item represents the purchase of a gift card.
Anchor to namename •String! non-null: The name of the product.
Anchor to originalTotaloriginalTotal •MoneyV2! non-null: The total price, excluding discounts, equal to the original unit price multiplied by quantity.
Anchor to originalTotalSetoriginalTotalSet •MoneyBag! non-null: The total price excluding discounts, equal to the original unit price multiplied by quantity.
Anchor to originalUnitPriceoriginalUnitPrice •MoneyV2! non-null: The line item price without any discounts applied.
Anchor to originalUnitPriceSetoriginalUnitPriceSet •MoneyBag! non-null: The price without any discounts applied.
Anchor to originalUnitPriceWithCurrencyoriginalUnitPriceWithCurrency •MoneyV2: The original custom line item input price.
Anchor to priceOverridepriceOverride •MoneyV2: The price override for the line item.
Anchor to productproduct •Product: The product for the line item.
Anchor to quantityquantity •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.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether physical shipping is required for the variant.
Anchor to skusku •String: The SKU number of the product variant.
Anchor to taxabletaxable •Boolean! non-null: Whether the variant is taxable.
Anchor to titletitle •String! non-null: The title of the product or variant. This field only applies to custom line items.
Anchor to totalDiscounttotalDiscount •MoneyV2! non-null: The total value of the discount.
Anchor to totalDiscountSettotalDiscountSet •MoneyBag! non-null: The total discount amount.
Anchor to uuiduuid •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.
Anchor to variantvariant •ProductVariant: The product variant for the line item.
Anchor to variantTitlevariantTitle •String: The name of the variant.
Anchor to vendorvendor •String: The name of the vendor who created the product variant.
Anchor to weightweight •Weight: The weight unit and value.
Anchor to bundleComponentsbundleComponents •[CalculatedDraftOrderLineItem!]! non-nullDeprecated
Anchor to discountedUnitPricediscountedUnitPrice •MoneyV2! non-nullDeprecated
Anchor to discountedUnitPriceSetdiscountedUnitPriceSet •MoneyBag! non-nullDeprecated

DraftOrderLineItem

•OBJECT

The line item for a draft order.

Anchor to appliedDiscountappliedDiscount •DraftOrderAppliedDiscount: The custom applied discount.
Anchor to approximateDiscountedUnitPriceSetapproximateDiscountedUnitPriceSet •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.
Anchor to componentscomponents •[DraftOrderLineItem!]! non-null: The components of the draft order line item.
Anchor to customcustom •Boolean! non-null: Whether the line item is custom (true) or contains a product variant (false).
Anchor to customAttributescustomAttributes •[Attribute!]! non-null: A list of attributes that represent custom features or special requests.
Anchor to customAttributesV2customAttributesV2 •[TypedAttribute!]! non-null: The list of additional information (metafields) with the associated types.
Anchor to discountedTotalSetdiscountedTotalSet •MoneyBag! non-null: The total price with discounts applied.
Anchor to fulfillmentServicefulfillmentService •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.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to imageimage •Image: The image of the product variant.
Anchor to isGiftCardisGiftCard •Boolean! non-null: Whether the line item represents the purchase of a gift card.
Anchor to namename •String! non-null: The name of the product.
Anchor to originalTotalSetoriginalTotalSet •MoneyBag! non-null: The total price excluding discounts, equal to the original unit price multiplied by quantity.
Anchor to originalUnitPriceSetoriginalUnitPriceSet •MoneyBag! non-null: The price without any discounts applied.
Anchor to originalUnitPriceWithCurrencyoriginalUnitPriceWithCurrency •MoneyV2: The original custom line item input price.
Anchor to priceOverridepriceOverride •MoneyV2: The price override for the line item.
Anchor to productproduct •Product: The product for the line item.
Anchor to quantityquantity •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.
Anchor to requiresShippingrequiresShipping •Boolean! non-null: Whether physical shipping is required for the variant.
Anchor to skusku •String: The SKU number of the product variant.
Anchor to taxabletaxable •Boolean! non-null: Whether the variant is taxable.
Anchor to taxLinestaxLines •[TaxLine!]! non-null: A list of tax lines.
Anchor to titletitle •String! non-null: The title of the product or variant. This field only applies to custom line items.
Anchor to totalDiscountSettotalDiscountSet •MoneyBag! non-null: The total discount amount.
Anchor to uuiduuid •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.
Anchor to variantvariant •ProductVariant: The product variant for the line item.
Anchor to variantTitlevariantTitle •String: The name of the variant.
Anchor to vendorvendor •String: The name of the vendor who created the product variant.
Anchor to weightweight •Weight: The weight unit and value.
Anchor to bundleComponentsbundleComponents •[DraftOrderLineItem!]! non-nullDeprecated
Anchor to discountedTotaldiscountedTotal •Money! non-nullDeprecated
Anchor to discountedUnitPricediscountedUnitPrice •Money! non-nullDeprecated
Anchor to discountedUnitPriceSetdiscountedUnitPriceSet •MoneyBag! non-nullDeprecated
Anchor to gramsgrams •Int Deprecated
Anchor to originalTotaloriginalTotal •Money! non-nullDeprecated
Anchor to originalUnitPriceoriginalUnitPrice •Money! non-nullDeprecated
Anchor to totalDiscounttotalDiscount •Money! non-nullDeprecated

ShippingLine

•OBJECT

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

Anchor to carrierIdentifiercarrierIdentifier •String: A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.
Anchor to codecode •String: A reference to the shipping method.
Anchor to currentDiscountedPriceSetcurrentDiscountedPriceSet •MoneyBag! non-null: The current shipping price after applying refunds, after applying discounts. If the parent `order.taxesIncluded`` field is true, then this price includes taxes. Otherwise, this field is the pre-tax price.
Anchor to customcustom •Boolean! non-null: Whether the shipping line is custom or not.
Anchor to deliveryCategorydeliveryCategory •String: The general classification of the delivery method.
Anchor to discountAllocationsdiscountAllocations •[DiscountAllocation!]! non-null: The discounts that have been allocated to the shipping line.
Anchor to discountedPriceSetdiscountedPriceSet •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.
Anchor to idid •ID: A globally-unique ID.
Anchor to isRemovedisRemoved •Boolean! non-null: Whether the shipping line has been removed.
Anchor to originalPriceSetoriginalPriceSet •MoneyBag! non-null: The pre-tax shipping price without any discounts applied.
Anchor to phonephone •String: The phone number at the shipping address.
Anchor to shippingRateHandleshippingRateHandle •String: A unique identifier for the shipping rate. The format can change without notice and isn't meant to be shown to users.
Anchor to sourcesource •String: Returns the rate source for the shipping line.
Anchor to taxLinestaxLines •[TaxLine!]! non-null: The TaxLine objects connected to this shipping line.
Anchor to titletitle •String! non-null: Returns the title of the shipping line.
Anchor to discountedPricediscountedPrice •MoneyV2! non-nullDeprecated
Anchor to originalPriceoriginalPrice •MoneyV2! non-nullDeprecated
Anchor to priceprice •Money! non-nullDeprecated
Anchor to requestedFulfillmentServicerequestedFulfillmentService •FulfillmentService Deprecated

Was this section helpful?

Anchor to Fields with this unionFields with this union

Anchor to DraftOrderPlatformDiscountAllocation.target DraftOrderPlatformDiscountAllocation.target •OBJECT: Price reduction allocations across the draft order's lines.

Was this section helpful?