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

orderEditRemoveLineItemDiscount mutation

Version unstable

Removes a discount that was added as part of this edit.

Required access

write_order_edits access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
discountApplicationId ( ID! ) required

The ID of the discount to remove.
id ( ID! ) required

The ID of the calculated order to remove the discount from.

Return fields

  • calculatedLineItem (CalculatedLineItem)

    The line item with the discount removed.

  • calculatedOrder (CalculatedOrder)

    An order with the edits calculated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Release candidate)

Removes a discount that was added as part of this edit.

Required access

write_order_edits access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
discountApplicationId ( ID! ) required

The ID of the discount to remove.
id ( ID! ) required

The ID of the calculated order to remove the discount from.

Return fields

  • calculatedLineItem (CalculatedLineItem)

    The line item with the discount removed.

  • calculatedOrder (CalculatedOrder)

    An order with the edits calculated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01 (Latest)

Removes a discount that was added as part of this edit.

Required access

write_order_edits access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
discountApplicationId ( ID! ) required

The ID of the discount to remove.
id ( ID! ) required

The ID of the calculated order to remove the discount from.

Return fields

  • calculatedLineItem (CalculatedLineItem)

    The line item with the discount removed.

  • calculatedOrder (CalculatedOrder)

    An order with the edits calculated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

Removes a discount that was added as part of this edit.

Required access

write_order_edits access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

Argument Description
discountApplicationId ( ID! ) required

The ID of the discount to remove.
id ( ID! ) required

The ID of the calculated order to remove the discount from.

Return fields

  • calculatedLineItem (CalculatedLineItem)

    The line item with the discount removed.

  • calculatedOrder (CalculatedOrder)

    An order with the edits calculated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.