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

discountAutomaticBulkDelete mutation

Version unstable

Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. Warning: All automatic discounts will be deleted if a blank search argument is provided.

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

ids ( [ID!] )

The IDs of the automatic discounts to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering automatic discounts on.

Return fields

job (Job)

The asynchronous job removing the automatic discounts.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2021-01 (Release candidate)

Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. Warning: All automatic discounts will be deleted if a blank search argument is provided.

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

ids ( [ID!] )

The IDs of the automatic discounts to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering automatic discounts on.

Return fields

job (Job)

The asynchronous job removing the automatic discounts.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2020-10 (Latest)

Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. Warning: All automatic discounts will be deleted if a blank search argument is provided.

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

ids ( [ID!] )

The IDs of the automatic discounts to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering automatic discounts on.

Return fields

job (Job)

The asynchronous job removing the automatic discounts.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2020-07

Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. Warning: All automatic discounts will be deleted if a blank search argument is provided.

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

ids ( [ID!] )

The IDs of the automatic discounts to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering automatic discounts on.

Return fields

job (Job)

The asynchronous job removing the automatic discounts.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2020-04

Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. Warning: All automatic discounts will be deleted if a blank search argument is provided.

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

ids ( [ID!] )

The IDs of the automatic discounts to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering automatic discounts on.

Return fields

job (Job)

The asynchronous job removing the automatic discounts.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2020-01

Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. Warning: All automatic discounts will be deleted if a blank search argument is provided.

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

ids ( [ID!] )

The IDs of the automatic discounts to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering automatic discounts on.

Return fields

job (Job)

The asynchronous job removing the automatic discounts.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2019-10 (Unsupported)

Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. Warning: All automatic discounts will be deleted if a blank search argument is provided.

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

ids ( [ID!] )

The IDs of the automatic discounts to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering automatic discounts on.

Return fields

job (Job)

The asynchronous job removing the automatic discounts.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2019-07 (Unsupported)

Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. Warning: All automatic discounts will be deleted if a blank search argument is provided.

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

ids ( [ID!] )

The IDs of the automatic discounts to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering automatic discounts on.

Return fields

job (Job)

The asynchronous job removing the automatic discounts.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.
Version 2019-04 (Unsupported)

Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. Warning: All automatic discounts will be deleted if a blank search argument is provided.

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

ids ( [ID!] )

The IDs of the automatic discounts to delete.
savedSearchId ( ID )

The ID of the saved search.
search ( String )

The search query for filtering automatic discounts on.

Return fields

job (Job)

The asynchronous job removing the automatic discounts.
userErrors ([DiscountUserError!]!)

List of errors that occurred executing the mutation.