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

productBulkAddPriceReductions mutation

Version 2020-01 (Unsupported)

Deprecation warning

Removed in 2020-04.

Adds the price reduction to products in bulk.

Required access

write_products 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
priceReduction ( PriceReductionInput! ) required

The price reduction to be applied to the prices.
productIds ( [ID!] )

A list of IDs for the products to have their price reduction added.
savedSearchId ( ID )

The ID of a saved search for filtering the products included in the mutation.
search ( String )

A search query for filtering the products included in the mutation.Use "" to update all products asynchronously.

PriceReductionInput fields

  • percentage (Int!) Required

    Percentage value of a price reduction.

Return fields

  • job (Job)

    The asynchronous job that adds the price reduction for the specified products.

  • skippedVariantIds ([ID!])

    A list of variant IDs that were skipped and not updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Deprecation warning

Removed in 2020-04.

Adds the price reduction to products in bulk.

Required access

write_products 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
priceReduction ( PriceReductionInput! ) required

The price reduction to be applied to the prices.
productIds ( [ID!] )

A list of IDs for the products to have their price reduction added.
savedSearchId ( ID )

The ID of a saved search for filtering the products included in the mutation.
search ( String )

A search query for filtering the products included in the mutation.Use "" to update all products asynchronously.

PriceReductionInput fields

  • percentage (Int!) Required

    Percentage value of a price reduction.

Return fields

  • job (Job)

    The asynchronous job that adds the price reduction for the specified products.

  • skippedVariantIds ([ID!])

    A list of variant IDs that were skipped and not updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Deprecation warning

Removed in 2020-04.

Adds the price reduction to products in bulk.

Required access

write_products 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
priceReduction ( PriceReductionInput! ) required

The price reduction to be applied to the prices.
productIds ( [ID!] )

A list of IDs for the products to have their price reduction added.
savedSearchId ( ID )

The ID of a saved search for filtering the products included in the mutation.
search ( String )

A search query for filtering the products included in the mutation.Use "" to update all products asynchronously.

PriceReductionInput fields

  • percentage (Int!) Required

    Percentage value of a price reduction.

Return fields

  • job (Job)

    The asynchronous job that adds the price reduction for the specified products.

  • skippedVariantIds ([ID!])

    A list of variant IDs that were skipped and not updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Deprecation warning

Removed in 2020-04.

Adds the price reduction to products in bulk.

Required access

write_products 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
priceReduction ( PriceReductionInput! ) required

The price reduction to be applied to the prices.
productIds ( [ID!] )

A list of IDs for the products to have their price reduction added.
savedSearchId ( ID )

The ID of a saved search for filtering the products included in the mutation.
search ( String )

A search query for filtering the products included in the mutation.Use "" to update all products asynchronously.

PriceReductionInput fields

  • percentage (Int!) Required

    Percentage value of a price reduction.

Return fields

  • job (Job)

    The asynchronous job that adds the price reduction for the specified products.

  • skippedVariantIds ([ID!])

    A list of variant IDs that were skipped and not updated.

  • userErrors ([UserError!]!)

    List of errors that occurred executing the mutation.