Price
Requires access scope. Also: The user must have a permission to view catalogs.
Represents a price list, including information about related prices and eligibility rules. You can use price lists to specify either fixed prices or adjusted relative prices that override initial product variant prices. Price lists are applied to customers using context rules, which determine price list eligibility.
For more information on price lists, refer to Support different pricing models.
Anchor to Fields and connectionsFields and connections
- Anchor to catalogcatalog•
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•
Prices Count Int!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•
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 quantityRulesquantity•
Rules QuantityRule Connection!non-null A list of quantity rules associated with the price list, ordered by product variants.
Anchor to QueriesQueries
- •query
Returns a price list resource by ID.
- •query
All price lists for a shop.
Anchor to MutationsMutations
- •mutation
Creates a price list. You can use the
mutation to create a new price list and associate it with a catalog. This enables you to sell your products with contextual pricing.- Anchor to inputinput•Price
List Create Input!required The properties of the new price list.
Arguments
- Anchor to priceListprice•
List The newly created price list.
- Anchor to userErrorsuser•
Errors [PriceList User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates the fixed prices for all variants for a product on a price list. You can use the
mutation to set or remove a fixed price for all variants of a product associated with the price list.- Anchor to priceListIdprice•
List Id ID!required The price list to update the prices for.
- Anchor to pricesToAddprices•
To Add A list of
that identifies which products to update the fixed prices for.- Anchor to pricesToDeleteByProductIdsprices•
To Delete By Product Ids A list of product IDs that identifies which products to remove the fixed prices for.
Arguments
- Anchor to priceListprice•
List The price list for which the fixed prices were modified.
- Anchor to pricesToAddProductsprices•
To Add Products The product for which the fixed prices were added.
- Anchor to pricesToDeleteProductsprices•
To Delete Products The product for which the fixed prices were deleted.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates fixed prices on a price list. You can use the
mutation to set a fixed price for specific product variants or to delete prices for variants associated with the price list.- Anchor to priceListIdprice•
List Id ID!required The price list that the prices will be updated against.
- Anchor to pricesToAddprices•
To Add [PriceList Price Input!]!required The fixed prices to add.
- Anchor to variantIdsToDeletevariant•
Ids To Delete [ID!]!required A list of product variant IDs to remove from the price list.
Arguments
- Anchor to deletedFixedPriceVariantIdsdeleted•
Fixed Price Variant Ids A list of deleted variant IDs for prices.
- Anchor to priceListprice•
List The price list for which the fixed prices were modified.
- Anchor to pricesAddedprices•
Added The prices that were added to the price list.
- Anchor to userErrorsuser•
Errors [PriceList Price User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a price list. If you modify the currency, then any fixed prices set on the price list will be deleted.
- •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
- Anchor to priceListprice•
List The updated price list.
- Anchor to userErrorsuser•
Errors [PriceList User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •