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

discountCodeRedeemCodeBulkDelete mutation

Version unstable

Asynchronously delete discount redeem codes in bulk. Specify the redeem codes to delete by providing a search query, a savedSearchId, or a list of redeem code IDs.

Required access

Apps must have write_discounts 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
discountId ( ID! ) required

The ID of the redeem code's discount.
ids ( [ID!] )

The IDs of the discount redeem codes to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering discount redeem codes.

Return fields

  • job (Job)

    The asynchronous job that deletes the discount redeem codes.

  • userErrors ([DiscountUserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Release candidate)

Asynchronously delete discount redeem codes in bulk. Specify the redeem codes to delete by providing a search query, a savedSearchId, or a list of redeem code IDs.

Required access

Apps must have write_discounts 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
discountId ( ID! ) required

The ID of the redeem code's discount.
ids ( [ID!] )

The IDs of the discount redeem codes to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering discount redeem codes.

Return fields

  • job (Job)

    The asynchronous job that deletes the discount redeem codes.

  • userErrors ([DiscountUserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-01 (Latest)

Asynchronously delete discount redeem codes in bulk. Specify the redeem codes to delete by providing a search query, a savedSearchId, or a list of redeem code IDs.

Required access

Apps must have write_discounts 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
discountId ( ID! ) required

The ID of the redeem code's discount.
ids ( [ID!] )

The IDs of the discount redeem codes to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering discount redeem codes.

Return fields

  • job (Job)

    The asynchronous job that deletes the discount redeem codes.

  • userErrors ([DiscountUserError!]!)

    List of errors that occurred executing the mutation.

Version 2020-10

Asynchronously delete discount redeem codes in bulk. Specify the redeem codes to delete by providing a search query, a savedSearchId, or a list of redeem code IDs.

Required access

Apps must have write_discounts 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
discountId ( ID! ) required

The ID of the redeem code's discount.
ids ( [ID!] )

The IDs of the discount redeem codes to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering discount redeem codes.

Return fields

  • job (Job)

    The asynchronous job that deletes the discount redeem codes.

  • userErrors ([DiscountUserError!]!)

    List of errors that occurred executing the mutation.