Products > Price Lists > priceListsModify
Commerce APIProductsPrice ListspriceListsModify
priceListsModify
POST:price_lists.json

Description

Modify one or multiple price lists.

Permission bit: "price_lists.modify"

Topic: Price Lists

Arguments

data: [PriceListModify!]!

Main argument for mutations.


ids: [String!]!

List of price list ids. See also: Unique Identifiers

Example: ["pl_EQzGqWoY"]


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

customer_group_ids: [String!]

Customer group IDs to match against


date_range: DateRangeCreate


display_price_difference: Boolean

Whether price difference should be displayed when this price list matches


name: String

Name of the price list

Example: "Winter Sale"

Valid when: name is not empty

Valid when: name's length doesn't exceed 250 characters


parent_price_list_id: String

Unique price list identifier. See also: Unique Identifiers

Example: "pl_EQzGqWoY"

Valid when: parent_price_list_id matches regexp pattern: ^pl_


priority: Int

Priority of the rule (rule with higher priority is to be evaluated first)

Example: 0


sales_channel_ids: [String!]

Sales channel IDs to match against


Result

[PriceList!]

Preview (typescript)

Loading module