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

priceListUpdate mutation

Version unstable

Update a price list. You can update a price list to make changes to percentage-based price adjustments. You can use the priceListUpdate mutation to update an existing price list for a country. This lets you change product pricing on a per country basis. As part of the mutation, you can change the name, percentage-based adjustment, currency, and country.

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.

input ( PriceListUpdateInput! ) required

Provides the input fields required to update a price list.

PriceListUpdateInput fields

  • A set of facts about buyer context used to determine price list eligibility.

  • currency (CurrencyCode)

    The three-letter code for fixed prices associated with this price list.

  • name (String)

    The unique name of the price list, used as a human-readable identifier.

  • Relative adjustments to other prices.

Return fields

Version 2021-07 (Release candidate)

Update a price list. You can update a price list to make changes to percentage-based price adjustments. You can use the priceListUpdate mutation to update an existing price list for a country. This lets you change product pricing on a per country basis. As part of the mutation, you can change the name, percentage-based adjustment, currency, and country.

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.

input ( PriceListUpdateInput! ) required

Provides the input fields required to update a price list.

PriceListUpdateInput fields

  • A set of facts about buyer context used to determine price list eligibility.

  • currency (CurrencyCode)

    The three-letter code for fixed prices associated with this price list.

  • name (String)

    The unique name of the price list, used as a human-readable identifier.

  • Relative adjustments to other prices.

Return fields

Version 2021-04 (Latest)

Update a price list. You can update a price list to make changes to percentage-based price adjustments. You can use the priceListUpdate mutation to update an existing price list for a country. This lets you change product pricing on a per country basis. As part of the mutation, you can change the name, percentage-based adjustment, currency, and country.

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.

input ( PriceListUpdateInput! ) required

Provides the input fields required to update a price list.

PriceListUpdateInput fields

  • A set of facts about buyer context used to determine price list eligibility.

  • currency (CurrencyCode)

    The three-letter code for fixed prices associated with this price list.

  • name (String)

    The unique name of the price list, used as a human-readable identifier.

  • Relative adjustments to other prices.

Return fields