Price
Requires access scope. Also: The user must have permission to view catalogs.
Error codes for failed contextual pricing operations.
Anchor to FieldsFields
- code (PriceListUserErrorCode)
- field ([String!])
- message (String!)
- Anchor to codecode•Price
List User Error Code The error code.
Show enum values
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- priceListCreate (PriceListCreatePayload)
- priceListDelete (PriceListDeletePayload)
- priceListUpdate (PriceListUpdatePayload)
- •mutation
Creates a
. Price lists enable contextual pricing by defining fixed prices or percentage-based adjustments.The price list requires a unique name, currency for fixed prices, and parent adjustment settings that determine how the system calculates prices relative to base prices. To apply contextual pricing, link the price list to a
Catalog. When that catalog's context is matched, customers receive the price list's prices.Learn more about building catalogs with price lists.
Show payload
- Anchor to inputinput•Price
List Create Input! required The properties of the new price list.
Show input fields
Arguments
- •mutation
Deletes a price list. For example, you can delete a price list so that it no longer applies for products in the associated market.
Show payload
- •ID!required
The ID of the price list to be deleted.
Arguments
- •ID!
- •mutation
Updates a
's configuration, including its name, currency,Catalogassociation, and pricing adjustments.Changing the currency removes all fixed prices from the price list. The affected
objects revert to prices calculated from the price list's adjustment settings.Show payload
- •ID!required
The ID of the price list to update.
- Anchor to inputinput•Price
List Update Input! required The input data used to update the price list.
Show input fields
Arguments
- •ID!