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

priceListDelete mutation

Version unstable

Delete a price list. You can use the priceListDelete mutation to delete a price list, so that it no longer applies for products in that country. To delete a price list, you need to specify the price list ID.

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
id ( ID! ) required

The ID for the price list to be deleted.

Return fields

  • deletedId (ID)

    The ID of the deleted price list.

  • userErrors ([PriceListUserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-07 (Release candidate)

Delete a price list. You can use the priceListDelete mutation to delete a price list, so that it no longer applies for products in that country. To delete a price list, you need to specify the price list ID.

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
id ( ID! ) required

The ID for the price list to be deleted.

Return fields

  • deletedId (ID)

    The ID of the deleted price list.

  • userErrors ([PriceListUserError!]!)

    List of errors that occurred executing the mutation.

Version 2021-04 (Latest)

Delete a price list. You can use the priceListDelete mutation to delete a price list, so that it no longer applies for products in that country. To delete a price list, you need to specify the price list ID.

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
id ( ID! ) required

The ID for the price list to be deleted.

Return fields

  • deletedId (ID)

    The ID of the deleted price list.

  • userErrors ([PriceListUserError!]!)

    List of errors that occurred executing the mutation.