Skip to main content

paginatedProductPrices

Prices across the catalog, paginated. Without productId it returns every price the filters match, so a price owner's whole list can be read in pages.

Business Rules​

  • At least one of productId or a price owner is required, so the list is always bounded by a product or by an owner.
  • priceableType and priceableId are provided together or omitted together. Together they return one owner's prices: a customer's, or a sales channel's.
  • Only prices owned by the authenticated company are returned.
  • productFilters are the product list filters, applied before pagination.
  • Archived prices are left out.

Ordering​

sortField defaults to the minimum quantity, where a tier with no minimum counts as zero and leads the ascending order as the base price.

Error Scenarios​

  • **NOT_FOUND**: the product does not belong to the active company.
  • **UNPROCESSABLE_CONTENT**: neither a product nor an owner was provided, or only one of priceableType and priceableId was.
  • **UNAUTHORIZED**: missing required permissions or invalid company access.

Permissions Required​

  • products:read_prices permission
paginatedProductPrices(
  after: String
  before: String
  filters: ProductPriceFilterInput
  first: Int
  last: Int
  productFilters: ProductFilterInput
  productId: ID
  sortField: ProductPriceSortFieldEnum = MINIMUM_QUANTITY
  sortType: SortTypeEnum = ASC
): ProductPriceConnection!

Arguments​

paginatedProductPrices.after ● String scalar common​

Returns the elements in the list that come after the specified cursor.

paginatedProductPrices.before ● String scalar common​

Returns the elements in the list that come before the specified cursor.

paginatedProductPrices.filters ● ProductPriceFilterInput input products​

Price filters: owner, date ranges, amounts, and quantity range.

paginatedProductPrices.first ● Int scalar common​

Returns the first _n_ elements from the list.

paginatedProductPrices.last ● Int scalar common​

Returns the last _n_ elements from the list.

paginatedProductPrices.productFilters ● ProductFilterInput input products​

The main product list filters, applied before pagination.

paginatedProductPrices.productId ● ID scalar common​

Limits the list to one product. Omit it to read across the catalog.

paginatedProductPrices.sortField ● ProductPriceSortFieldEnum enum products​

Column to sort by.

paginatedProductPrices.sortType ● SortTypeEnum enum common​

Sort direction.

Type​

ProductPriceConnection object common​

The connection type for ProductPrice.