DraftOrderPlatformDiscountAllocationTarget
Requires access scope.
The element of the draft being discounted.
Anchor to Possible typesPossible types
- •OBJECT
The calculated line item for a draft order.
- applied
Discount •DraftOrder Applied Discount The custom applied discount.
- approximate
Discounted •Unit Price Set Moneynon-nullBag! The
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.- bundle
Components •[Calculatednon-nullDraft Order Line Item!]! 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
).- custom
Attributes •[Attribute!]!non-null A list of attributes that represent custom features or special requests.
- custom
Attributes •V2 [Typednon-nullAttribute!]! The list of additional information (metafields) with the associated types.
- discounted
Total •Moneynon-nullV2! The total price with discounts applied.
- discounted
Total •Set Moneynon-nullBag! The total price with discounts applied.
- fulfillment
Service •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.
- is
Gift •Card Boolean!non-null Whether the line item represents the purchase of a gift card.
- name•String!non-null
The name of the product.
- original
Total •Moneynon-nullV2! The total price, excluding discounts, equal to the original unit price multiplied by quantity.
- original
Total •Set Moneynon-nullBag! The total price excluding discounts, equal to the original unit price multiplied by quantity.
- original
Unit •Price Moneynon-nullV2! The line item price without any discounts applied.
- original
Unit •Price Set Moneynon-nullBag! The price without any discounts applied.
- original
Unit •Price With Currency 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.
- requires
Shipping •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.
- total
Discount •Moneynon-nullV2! The total value of the discount.
- total
Discount •Set Moneynon-nullBag! 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•Product
Variant The product variant for the line item.
- variant
Title •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.
- discounted
Unit •Price Moneynon-nullDeprecatedV2! The unit price with discounts applied. Use
instead.
- discounted
Unit •Price Set Moneynon-nullDeprecatedBag! The unit price with discounts applied. Use
instead.
- applied
- •OBJECT
The line item for a draft order.
- applied
Discount •DraftOrder Applied Discount The custom applied discount.
- approximate
Discounted •Unit Price Set Moneynon-nullBag! The
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.- bundle
Components •[Draftnon-nullOrder Line Item!]! The list of bundle components if applicable.
- custom•Boolean!non-null
Whether the line item is custom (
true
) or contains a product variant (false
).- custom
Attributes •[Attribute!]!non-null A list of attributes that represent custom features or special requests.
- custom
Attributes •V2 [Typednon-nullAttribute!]! The list of additional information (metafields) with the associated types.
- discounted
Total •Set Moneynon-nullBag! The total price with discounts applied.
- fulfillment
Service •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.
- is
Gift •Card Boolean!non-null Whether the line item represents the purchase of a gift card.
- name•String!non-null
The name of the product.
- original
Total •Set Moneynon-nullBag! The total price excluding discounts, equal to the original unit price multiplied by quantity.
- original
Unit •Price Set Moneynon-nullBag! The price without any discounts applied.
- original
Unit •Price With Currency 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.
- requires
Shipping •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.
- tax
Lines •[Taxnon-nullLine!]! A list of tax lines.
- title•String!non-null
The title of the product or variant. This field only applies to custom line items.
- total
Discount •Set Moneynon-nullBag! 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•Product
Variant The product variant for the line item.
- variant
Title •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.
- discounted
Total •Money!non-nullDeprecated The line item price, in shop currency, after discounts are applied. Use
instead.
- discounted
Unit •Price Money!non-nullDeprecated The
divided by
quantity
, equal to the value of the discount per unit in the shop currency. Useinstead.
- discounted
Unit •Price Set Moneynon-nullDeprecatedBag! The unit price with discounts applied. Use
instead.
- grams•IntDeprecated
The weight of the line item in grams. Use
weight
instead.- original
Total •Money!non-nullDeprecated The total price, in shop currency, excluding discounts, equal to the original unit price multiplied by quantity. Use
instead.
- original
Unit •Price Money!non-nullDeprecated The price, in shop currency, without any discounts applied. Use
instead.
- total
Discount •Money!non-nullDeprecated The total discount applied in shop currency. Use
instead.
- applied
- •OBJECT
Represents the shipping details that the customer chose for their order.
- carrier
Identifier •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.
- delivery
Category •String The general classification of the delivery method.
- discount
Allocations •[Discountnon-nullAllocation!]! The discounts that have been allocated to the shipping line.
- discounted
Price •Set Moneynon-nullBag! 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.
- is
Removed •Boolean!non-null Whether the shipping line has been removed.
- original
Price •Set Moneynon-nullBag! The pre-tax shipping price without any discounts applied.
- phone•String
The phone number at the shipping address.
- shipping
Rate •Handle 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.
- tax
Lines •[Taxnon-nullLine!]! The TaxLine objects connected to this shipping line.
- title•String!non-null
Returns the title of the shipping line.
- discounted
Price •Moneynon-nullDeprecatedV2! 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
instead.
- original
Price •Moneynon-nullDeprecatedV2! The pre-tax shipping price without any discounts applied. Use
instead.
- price•Money!non-nullDeprecated
Returns the price of the shipping line. Use
instead.
- requested
Fulfillment •Service FulfillmentDeprecatedService 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.
- carrier
Anchor to Fields with this unionFields with this union
- •OBJECT
The element of the draft being discounted.