DraftOrderAppliedDiscount object

Version 2020-01 (Release candidate)

The order-level discount applied to a draft order.

Required access

read_draft_orders access scope

Fields

amountV2 (MoneyV2!)

Amount of money discounted.

description (String!)

Description of the order-level discount.

title (String)

Name of the order-level discount.

value (Float!)

Amount of the order level discount (when value_type is percentage, the value in this field is the percentage discount).

valueType (DraftOrderAppliedDiscountType!)

Type of the order-level discount.

Types that return DraftOrderAppliedDiscount

Deprecated fields

Show/Hide
amount (Money!) deprecated

Amount of the order-level discount that is applied to the draft order.

Deprecation warning

Use amountV2 instead

Version 2019-10 (Latest)

The order-level discount applied to a draft order.

Required access

read_draft_orders access scope

Fields

amountV2 (MoneyV2!)

Amount of money discounted.

description (String!)

Description of the order-level discount.

title (String)

Name of the order-level discount.

value (Float!)

Amount of the order level discount (when value_type is percentage, the value in this field is the percentage discount).

valueType (DraftOrderAppliedDiscountType!)

Type of the order-level discount.

Types that return DraftOrderAppliedDiscount

Deprecated fields

Show/Hide
amount (Money!) deprecated

Amount of the order-level discount that is applied to the draft order.

Deprecation warning

Use amountV2 instead

Version 2019-07

The order-level discount applied to a draft order.

Required access

read_draft_orders access scope

Fields

amountV2 (MoneyV2!)

Amount of money discounted.

description (String!)

Description of the order-level discount.

title (String)

Name of the order-level discount.

value (Float!)

Amount of the order level discount (when value_type is percentage, the value in this field is the percentage discount).

valueType (DraftOrderAppliedDiscountType!)

Type of the order-level discount.

Types that return DraftOrderAppliedDiscount

Deprecated fields

Show/Hide
amount (Money!) deprecated

Amount of the order-level discount that is applied to the draft order.

Deprecation warning

Use amountV2 instead

Version 2019-04

The order-level discount applied to a draft order.

Required access

read_draft_orders access scope

Fields

amountV2 (MoneyV2!)

Amount of money discounted.

description (String!)

Description of the order-level discount.

title (String)

Name of the order-level discount.

value (Float!)

Amount of the order level discount (when value_type is percentage, the value in this field is the percentage discount).

valueType (DraftOrderAppliedDiscountType!)

Type of the order-level discount.

Types that return DraftOrderAppliedDiscount

Deprecated fields

Show/Hide
amount (Money!) deprecated

Amount of the order-level discount that is applied to the draft order.

Deprecation warning

Use amountV2 instead

Sign up for a Partner account to get started.

Sign up