API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04 Unsupported
API version: 2020-01 Unsupported

DraftOrderAppliedDiscountInput input object

Version unstable

The input fields for applying an order-level discount to a draft order.

Input fields

  • amount (Money)

    The applied amount of the discount.

  • description (String)

    Reason for the discount.

  • title (String)

    Title of the discount.

  • value (Float!) Required

    The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

  • valueType (DraftOrderAppliedDiscountType!) Required

    The type of discount.

Version 2021-07 (Release candidate)

The input fields for applying an order-level discount to a draft order.

Input fields

  • amount (Money)

    The applied amount of the discount.

  • description (String)

    Reason for the discount.

  • title (String)

    Title of the discount.

  • value (Float!) Required

    The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

  • valueType (DraftOrderAppliedDiscountType!) Required

    The type of discount.

Version 2021-04 (Latest)

The input fields for applying an order-level discount to a draft order.

Input fields

  • amount (Money)

    The applied amount of the discount.

  • description (String)

    Reason for the discount.

  • title (String)

    Title of the discount.

  • value (Float!) Required

    The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

  • valueType (DraftOrderAppliedDiscountType!) Required

    The type of discount.

Version 2021-01

The input fields for applying an order-level discount to a draft order.

Input fields

  • amount (Money)

    The applied amount of the discount.

  • description (String)

    Reason for the discount.

  • title (String)

    Title of the discount.

  • value (Float!) Required

    The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

  • valueType (DraftOrderAppliedDiscountType!) Required

    The type of discount.

Version 2020-10

The input fields for applying an order-level discount to a draft order.

Input fields

  • amount (Money)

    The applied amount of the discount.

  • description (String)

    Reason for the discount.

  • title (String)

    Title of the discount.

  • value (Float!) Required

    The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

  • valueType (DraftOrderAppliedDiscountType!) Required

    The type of discount.

Version 2020-07

The input fields for applying an order-level discount to a draft order.

Input fields

  • amount (Money)

    The applied amount of the discount.

  • description (String)

    Reason for the discount.

  • title (String)

    Title of the discount.

  • value (Float!) Required

    The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

  • valueType (DraftOrderAppliedDiscountType!) Required

    The type of discount.

Version 2020-04 (Unsupported)

The input fields for applying an order-level discount to a draft order.

Input fields

  • amount (Money)

    The applied amount of the discount.

  • description (String)

    Reason for the discount.

  • title (String)

    Title of the discount.

  • value (Float!) Required

    The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

  • valueType (DraftOrderAppliedDiscountType!) Required

    The type of discount.

Version 2020-01 (Unsupported)

The input fields for applying an order-level discount to a draft order.

Input fields

  • amount (Money)

    The applied amount of the discount.

  • description (String)

    Reason for the discount.

  • title (String)

    Title of the discount.

  • value (Float!) Required

    The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

  • valueType (DraftOrderAppliedDiscountType!) Required

    The type of discount.

Version 2019-10 (Unsupported)

The input fields for applying an order-level discount to a draft order.

Input fields

  • amount (Money)

    The applied amount of the discount.

  • description (String)

    Reason for the discount.

  • title (String)

    Title of the discount.

  • value (Float!) Required

    The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

  • valueType (DraftOrderAppliedDiscountType!) Required

    The type of discount.

Version 2019-07 (Unsupported)

The input fields for applying an order-level discount to a draft order.

Input fields

  • amount (Money)

    The applied amount of the discount.

  • description (String)

    Reason for the discount.

  • title (String)

    Title of the discount.

  • value (Float!) Required

    The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

  • valueType (DraftOrderAppliedDiscountType!) Required

    The type of discount.

Version 2019-04 (Unsupported)

The input fields for applying an order-level discount to a draft order.

Input fields

  • amount (Money)

    The applied amount of the discount.

  • description (String)

    Reason for the discount.

  • title (String)

    Title of the discount.

  • value (Float!) Required

    The value of the discount. If the type of the discount is fixed amount, then this is a fixed dollar amount. If the type is percentage, then this is the percentage.

  • valueType (DraftOrderAppliedDiscountType!) Required

    The type of discount.