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-10 (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-07 (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-04

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.