Price
Requires access scope. Also: The user must have a permission to view catalogs.
A list that defines pricing for product variants. Price lists override default product prices with either fixed prices or percentage-based adjustments.
Each price list associates with a Catalog to determine which customers see the pricing. The catalog's context rules control when the price list applies, such as for specific markets, company locations, or apps.
Learn how to support different pricing models.
Anchor to FieldsFields
- Anchor to catalogcatalog•Catalog
The catalog that the price list is associated with.
- Anchor to currencycurrency•Currency
Code! non-null The currency for fixed prices associated with this price list.
- Anchor to fixedPricesCountfixed•Int!
Prices Count non-null The number of fixed prices on the price list.
- •ID!non-null
A globally-unique ID.
- Anchor to namename•String!non-null
The unique name of the price list, used as a human-readable identifier.
- Anchor to parentparent•Price
List Parent Relative adjustments to other prices.
- Anchor to pricesprices•Price
List Price Connection! non-null A list of prices associated with the price list.
- Anchor to originTypeorigin•Price
Type List Price Origin Type The origin of this price, either fixed (defined on the price list) or relative (calculated using an adjustment via a price list parent configuration).
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Arguments
- Anchor to quantityRulesquantity•Quantity
Rules Rule Connection! non-null A list of quantity rules associated with the price list, ordered by product variants.
- Anchor to originTypeorigin•Quantity
Type Rule Origin Type Whether the quantity rule is fixed (defined on the price list) or relative (the default quantity rule for the shop).
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
Anchor to QueriesQueries
- •query
Returns a
by ID. You can use price lists to specify either fixed prices or adjusted relative prices that override initialProductprices.Price lists enable contextual pricing for the
Catalogthey are associated to. Each price list can define fixed prices for specificobjects or percentage-based adjustments relative to other prices.- •ID!required
The ID of the
to return.
Arguments
- •ID!
- •query
All price lists for a shop.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Price
Key List Sort Keys Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Arguments
Anchor to MutationsMutations
- •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.
- Anchor to inputinput•Price
List Create Input! required The properties of the new price list.
Arguments
- •mutation
Sets or removes fixed prices for all variants of a
Producton a. Simplifies pricing management when all variants of a product should have the same price on a price list, rather than setting individual variant prices.When you add a fixed price for a product, all its
objects receive the same price on the price list. When you remove a product's fixed prices, all variant prices revert to the price list's adjustment rules.- Anchor to pricesToAddprices•[Price
To Add List Product Price Input!] A list of
that identifies which products to update the fixed prices for.- Anchor to pricesToDeleteByProductIdsprices•[ID!]
To Delete By Product Ids A list of product IDs that identifies which products to remove the fixed prices for.
- Anchor to priceListIdprice•ID!
List Id required The price list to update the prices for.
Arguments
- •mutation
Updates fixed prices on a
. This mutation lets you add new fixed prices for specificobjects and remove existing prices in a single operation.Use this mutation to modify variant pricing on a price list by providing prices to add and variant IDs to delete.
Learn more about setting fixed prices for product variants.
- Anchor to priceListIdprice•ID!
List Id required The price list that the prices will be updated against.
- Anchor to pricesToAddprices•[Price
To Add List Price Input!]! required The fixed prices to add.
- Anchor to variantIdsToDeletevariant•[ID!]!
Ids To Delete required A list of product variant IDs to remove from the price list.
Arguments
- •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.- •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.
Arguments
- •ID!