PriceList object

Version unstable

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 using the price list API.

Required access

read_products access scope.

Connections

  • A list of prices associated with the price list.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    originType ( PriceListPriceOriginType )

    The origin of this price, either fixed (defined on the price list) or relative (calculated using an adjustment via a price list parent configuration).

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

Fields

  • contextRule (PriceListContextRule)

    A set of facts about the customer, used to determine price list eligibility.

  • currency (CurrencyCode!)

    The currency for fixed prices associated with this price list.

  • id (ID!)

    Globally unique identifier.

  • name (String!)

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

  • parent (PriceListParent)

    Relative adjustments to other prices.

Types that return PriceList

Mutations for PriceList

  • Create a price list. You can use the priceListCreate mutation to create a new price list for a country. This lets you sell your products with international pricing.

  • Delete a price list. You can use the priceListDelete mutation to delete a price list, so that it no longer applies for products in that country. To delete a price list, you need to specify the price list ID.

  • Creates or updates fixed prices on a price list. You can use the priceListFixedPricesAdd mutation to set a fixed price for specific product variants. This lets you change product variant pricing on a per country basis. Any existing fixed price list prices for these variants will be overwritten.

  • Deletes specific prices from a price list using a product variant ID. You can use the priceListFixedPricesDelete mutation to delete a partial set of prices on a price list. After deletion, the prices no longer apply for products in the country.

  • 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.

Implements

Version unstable

An auto-generated type for paginating through multiple PriceLists.

Fields

Types that return PriceList