Skip to main content
Log inSign up

Shopify uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.

Anchor to DraftOrderPlatformDiscountAllocationTarget

DraftOrderPlatformDiscountAllocationTarget

union

Requires read_draft_orders access scope.

The element of the draft being discounted.

•
OBJECT

The calculated line item for a draft order.

appliedDiscount•

The custom applied discount.

approximateDiscountedUnitPriceSet•
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•
non-null

The bundle components of the draft order line item.

custom•
non-null

Whether the line item is custom (true) or contains a product variant (false).

customAttributes•
non-null

A list of attributes that represent custom features or special requests.

customAttributesV2•
non-null

The list of additional information (metafields) with the associated types.

discountedTotal•
non-null

The total price with discounts applied.

discountedTotalSet•
non-null

The total price with discounts applied.

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•

The image associated with the draft order line item.

isGiftCard•
non-null

Whether the line item represents the purchase of a gift card.

name•
non-null

The name of the product.

originalTotal•
non-null

The total price, excluding discounts, equal to the original unit price multiplied by quantity.

originalTotalSet•
non-null

The total price excluding discounts, equal to the original unit price multiplied by quantity.

originalUnitPrice•
non-null

The line item price without any discounts applied.

originalUnitPriceSet•
non-null

The price without any discounts applied.

originalUnitPriceWithCurrency•

The original custom line item input price.

product•

The product for the line item.

quantity•
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•
non-null

Whether physical shipping is required for the variant.

sku•

The SKU number of the product variant.

taxable•
non-null

Whether the variant is taxable.

title•
non-null

The title of the product or variant. This field only applies to custom line items.

totalDiscount•
non-null

The total value of the discount.

totalDiscountSet•
non-null

The total discount amount.

uuid•
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•

The product variant for the line item.

variantTitle•

The name of the variant.

vendor•

The name of the vendor who created the product variant.

weight•

The weight unit and value.

discountedUnitPrice•
non-nullDeprecated

The unit price with discounts applied. Use approximateDiscountedUnitPriceSet instead.

discountedUnitPriceSet•
non-nullDeprecated

The unit price with discounts applied. Use approximateDiscountedUnitPriceSet instead.

•
OBJECT

The line item for a draft order.

appliedDiscount•

The custom applied discount.

approximateDiscountedUnitPriceSet•
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•
non-null

The list of bundle components if applicable.

custom•
non-null

Whether the line item is custom (true) or contains a product variant (false).

customAttributes•
non-null

A list of attributes that represent custom features or special requests.

customAttributesV2•
non-null

The list of additional information (metafields) with the associated types.

discountedTotalSet•
non-null

The total price with discounts applied.

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•
non-null

A globally-unique ID.

image•

The image of the product variant.

isGiftCard•
non-null

Whether the line item represents the purchase of a gift card.

name•
non-null

The name of the product.

originalTotalSet•
non-null

The total price excluding discounts, equal to the original unit price multiplied by quantity.

originalUnitPriceSet•
non-null

The price without any discounts applied.

originalUnitPriceWithCurrency•

The original custom line item input price.

product•

The product for the line item.

quantity•
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•
non-null

Whether physical shipping is required for the variant.

sku•

The SKU number of the product variant.

taxable•
non-null

Whether the variant is taxable.

taxLines•
non-null

A list of tax lines.

title•
non-null

The title of the product or variant. This field only applies to custom line items.

totalDiscountSet•
non-null

The total discount amount.

uuid•
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•

The product variant for the line item.

variantTitle•

The name of the variant.

vendor•

The name of the vendor who created the product variant.

weight•

The weight unit and value.

discountedTotal•
non-nullDeprecated

The line item price, in shop currency, after discounts are applied. Use discountedTotalSet instead.

discountedUnitPrice•
non-nullDeprecated

The discountedTotal divided by quantity, equal to the value of the discount per unit in the shop currency. Use approximateDiscountedUnitPriceSet instead.

discountedUnitPriceSet•
non-nullDeprecated

The unit price with discounts applied. Use approximateDiscountedUnitPriceSet instead.

grams•
Deprecated

The weight of the line item in grams. Use weight instead.

originalTotal•
non-nullDeprecated

The total price, in shop currency, excluding discounts, equal to the original unit price multiplied by quantity. Use originalTotalSet instead.

originalUnitPrice•
non-nullDeprecated

The price, in shop currency, without any discounts applied. Use originalUnitPriceWithCurrency instead.

totalDiscount•
non-nullDeprecated

The total discount applied in shop currency. Use totalDiscountSet instead.

•
OBJECT

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

carrierIdentifier•

A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service.

code•

A reference to the shipping method.

custom•
non-null

Whether the shipping line is custom or not.

deliveryCategory•

The general classification of the delivery method.

discountAllocations•
non-null

The discounts that have been allocated to the shipping line.

discountedPriceSet•
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•

A globally-unique ID.

isRemoved•
non-null

Whether the shipping line has been removed.

originalPriceSet•
non-null

The pre-tax shipping price without any discounts applied.

phone•

The phone number at the shipping address.

shippingRateHandle•

A unique identifier for the shipping rate. The format can change without notice and isn't meant to be shown to users.

source•

Returns the rate source for the shipping line.

taxLines•
non-null

The TaxLine objects connected to this shipping line.

title•
non-null

Returns the title of the shipping line.

discountedPrice•
non-nullDeprecated

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. Use discountedPriceSet instead.

originalPrice•
non-nullDeprecated

The pre-tax shipping price without any discounts applied. Use originalPriceSet instead.

price•
non-nullDeprecated

Returns the price of the shipping line. Use originalPriceSet instead.

requestedFulfillmentService•
Deprecated

The fulfillment service requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service. requestedFulfillmentService is no longer in use. Order routing does not use the requestedFulfillmentService during order and fulfillment order creation.


Was this section helpful?

Anchor to Fields with this unionFields with this union


Was this section helpful?