---
title: entities.productPriceList
description: Read product price list records with the productPriceList repository, and change them with the product price list mutations. Same records as the REST ProductPriceLists entity.
canonical: https://developers.coevera.com/reference/graphql/product-price-list/
section: graphql
verification: schema
generatedFrom: schema f155746 (2026-10-20)
publisher: Coevera
---

# entities.productPriceList

Read product price list records with the productPriceList repository, and change them with the product price list mutations. Same records as the REST ProductPriceLists entity.

REST: [ProductPriceLists](https://developers.coevera.com/reference/rest/product-price-lists.md).

## Queries

- `getById(entityId: ID!): ProductPriceListEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [ProductPriceListEntity!]!` Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
- `getAll(limit: Int, offset: Int, filter: ProductPriceListFilterInput, orderBy: [ProductPriceListOrderByInput!], includeDeleted: Boolean): [ProductPriceListEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: ProductPriceListFilterInput, orderBy: [ProductPriceListOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): ProductPriceListEntityConnection` Returns the records that match the filter as a cursor-paginated connection.
- `getChangedFieldsSinceRevision(id: UUID!, revision: Int!): [UUID!]!` Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.

## Mutations

- `createProductPriceList(input: CreateProductPriceListInput!, validationLevel: [ValidationLevel!]): CreateProductPriceListPayload` Create one record.
- `updateProductPriceList(input: UpdateProductPriceListInput!, action: UpdateProductPriceListActionEnum, validationLevel: [ValidationLevel!], sessionIdToUpdate: String): UpdateProductPriceListPayload` Update fields.
- `bulkUpdateProductPriceList(input: [CreateOrUpdateProductPriceListInput!]!, deleteInput: [DeleteProductPriceListInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput): BulkUpdateProductPriceListPayload` Create or update many; per-item results.
- `deleteProductPriceList(input: DeleteProductPriceListInput!): DeleteProductPriceListPayload` Soft-delete.

## Types

### ProductPriceListEntity (object)

Price list with product prices per currency, applied to opportunities and quotes while it is active.

- `isDeleteProtected: Boolean!` True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
- `id: ID!` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `description: String` Free-form description of the price list.
- `endDate: Date` Date when the price list expires. Empty means open-ended.
- `isActive: Boolean` Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates.
- `name: String!` Name of the entity and its default text representation.
- `rules: FieldFilter` Conditions that determine which opportunities or quotes the price list applies to (for example by sales unit, account or custom field).
- `startDate: Date` Date when the price list becomes active. Empty means immediately.
- `type: ProductPriceListTypeEnum` Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled).
- `revision: Int` Revision when entity was lastly changed.
- `isDefault: Boolean!` True for the team space default price list, which cannot be deleted. Read-only.
- `status: ProductPriceListStatusEnum!` Effective status of the price list (Active, Inactive, Scheduled, Expired). Read-only; derived from isActive and the start/end dates.
- `productPriceListPrices: ProductPriceListPriceEntityConnection (8 args)` Per-product, per-currency prices configured in the price list.
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### ProductPriceListEntityConnection (object)

Paginated list of ProductPriceList records.

- `pageInfo: PageInfo!` Pagination data for this connection.
- `edges: [ProductPriceListEntityEdge]!` Contains the nodes in this connection.
- `totalCount: Int` Total number of items in the connection.

### ProductPriceListEntityEdge (object)

A Relay edge containing a `ProductPriceListEntity` and its cursor.

- `node: ProductPriceListEntity` The item at the end of the edge
- `cursor: String!` A cursor for use in pagination

### ProductPriceListFilterInput (input)

Filter conditions for ProductPriceList records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

- `OR: [ProductPriceListFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [ProductPriceListFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: ProductPriceListFilterInput` Matches records that do not meet this filter.
- `globalSearchQuery: String` Search term matched against the fields that the global search covers for this entity.
- `id: EntityFilterStringField` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: EntityFilterDateTimeField` Last modification time.
- `created: EntityFilterDateTimeField` Creation time.
- `description: EntityFilterStringField` Free-form description of the price list.
- `isActive: Boolean` Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates.
- `name: EntityFilterStringField` Name of the entity and its default text representation.
- `type: ProductPriceListTypeEnumFilterInput` Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled).
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `isDefault: Boolean` True for the team space default price list, which cannot be deleted. Read-only.
- `status: ProductPriceListStatusEnum` Effective status of the price list (Active, Inactive, Scheduled, Expired). Read-only; derived from isActive and the start/end dates.
- `productPriceListPrices: ProductPriceListPriceFilterInput` Per-product, per-currency prices configured in the price list. Matches records where a related record meets these conditions.

### ProductPriceListOrderByInput (input)

Sorting of ProductPriceList records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

- `id: OrderByEnum` Unique identifier of entity.
- `isDeleted: OrderByEnum` Specifies if the entity is considered deleted.
- `modified: OrderByEnum` Last modification time.
- `created: OrderByEnum` Creation time.
- `description: OrderByEnum` Free-form description of the price list.
- `endDate: OrderByEnum` Date when the price list expires. Empty means open-ended.
- `isActive: OrderByEnum` Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates.
- `name: OrderByEnum` Name of the entity and its default text representation.
- `startDate: OrderByEnum` Date when the price list becomes active. Empty means immediately.
- `type: OrderByEnum` Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled).
- `revision: OrderByEnum` Revision when entity was lastly changed.
- `isDefault: OrderByEnum` True for the team space default price list, which cannot be deleted. Read-only.

### ProductPriceListTypeEnumFilterInput (input)

Conditions on an enumeration field. Several conditions given together must all match.

- `eq: [ProductPriceListTypeEnum!]` Matches any of the listed values.
- `NOT: ProductPriceListTypeEnumFilterInput` Matches values that do not meet this condition.

### CreateOrUpdateProductPriceListInput (input)

Field values of a ProductPriceList record to create, or to update when its id is set.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `description: String` Free-form description of the price list.
- `endDate: Date` Date when the price list expires. Empty means open-ended.
- `isActive: Boolean` Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates.
- `name: String` Name of the entity and its default text representation.
- `rules: JSONString` Filter expression — a FieldFilter JSON object — deciding which records (e.g. accounts, opportunities) the price list applies to. Empty when it applies to all records. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/f/#FieldFilter
- `startDate: Date` Date when the price list becomes active. Empty means immediately.
- `type: ProductPriceListTypeEnum` Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled).
- `revision: Int` Revision when entity was lastly changed.
- `productPriceListPrices: [CreateProductPriceListPriceNoProductPriceListBackrefInput!]` Per-product, per-currency prices configured in the price list.

### CreateProductPriceListInput (input)

Field values of a new ProductPriceList record.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `description: String` Free-form description of the price list.
- `endDate: Date` Date when the price list expires. Empty means open-ended.
- `isActive: Boolean` Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates.
- `name: String!` Name of the entity and its default text representation.
- `rules: JSONString` Filter expression — a FieldFilter JSON object — deciding which records (e.g. accounts, opportunities) the price list applies to. Empty when it applies to all records. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/f/#FieldFilter
- `startDate: Date` Date when the price list becomes active. Empty means immediately.
- `type: ProductPriceListTypeEnum` Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled).
- `revision: Int` Revision when entity was lastly changed.
- `productPriceListPrices: [CreateProductPriceListPriceNoProductPriceListBackrefInput!]` Per-product, per-currency prices configured in the price list.

### CreateProductPriceListPriceNoProductPriceListBackrefInput (input)

Field values of a new ProductPriceListPrice record, created together with the record it belongs to.

- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `currencyId: ID!` Id of the currency the price is denominated in.
- `price: Float` Price amount stored at 6-decimal precision; values set via the API are rounded.
- `productId: ID!` Id of the product the price applies to.
- `settings: ProductPriceListPriceSettingsJSONString!` Per-price access controls (e.g. which user roles can override this price). Stored as a JSON object.
- `revision: Int` Revision when entity was lastly changed.

### DeleteProductPriceListInput (input)

Id of the ProductPriceList record to delete.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID!` Unique identifier of entity.

### UpdateProductPriceListInput (input)

Id of a ProductPriceList record and the field values to change.

- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
- `id: ID!` Unique identifier of entity.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `description: String` Free-form description of the price list.
- `endDate: Date` Date when the price list expires. Empty means open-ended.
- `isActive: Boolean` Master switch for the price list. Inactive price lists are not applied to opportunities or quotes regardless of dates.
- `name: String` Name of the entity and its default text representation.
- `rules: JSONString` Filter expression — a FieldFilter JSON object — deciding which records (e.g. accounts, opportunities) the price list applies to. Empty when it applies to all records. Validated on write. Full structure: https://developers.coevera.com/reference/graphql/types/f/#FieldFilter
- `startDate: Date` Date when the price list becomes active. Empty means immediately.
- `type: ProductPriceListTypeEnum` Kind of price list: a regular price list (Standard), or a price schedule with special prices that take precedence over standard price lists while active (Scheduled).
- `revision: Int` Revision when entity was lastly changed.
- `productPriceListPrices: [CreateProductPriceListPriceNoProductPriceListBackrefInput!]` Per-product, per-currency prices configured in the price list.

### BulkUpdateProductPriceListPayload (object)

Result of the bulkUpdateProductPriceList mutation.

- `result: BulkUpdateResults!` Ids of the created, updated and deleted records, and the items that failed.

### CreateProductPriceListPayload (object)

Result of the createProductPriceList mutation.

- `productPriceList: ProductPriceListEntity` The created record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

### DeleteProductPriceListPayload (object)

Result of the deleteProductPriceList mutation.

- `productPriceList: ProductPriceListEntity` The deleted record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

### UpdateProductPriceListPayload (object)

Result of the updateProductPriceList mutation.

- `productPriceList: ProductPriceListEntity` The updated record.
- `clientMutationId: String` Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

### FieldFilter (object)

Filter definition: conditions on a record type and on related records, grouped in filter boxes and combined with And, Or or a custom formula.

- `operator: FilterGroupOperator!` How the filter boxes combine — And or Or.
- `formula: String` Optional boolean formula combining the filter boxes by their number.
- `filterMainBox: MainFilterBox!` Primary group of filter conditions.
- `filterSiblingBoxes: [FilterBox!]!` Additional condition groups, combined per operator/formula.
- `isEnabled: Boolean!` When false, the filter is ignored and all records match.

### ProductPriceListStatusEnum (enum)

Effective status of a price list.

- `Active` The price list is switched on and within its validity dates.
- `Inactive` The price list is switched off.
- `Scheduled` The price list's start date is in the future.
- `Expired` The price list's end date has passed.

### ProductPriceListTypeEnum (enum)

Kind of price list.

- `Standard` Regular price list that offers product prices to matching records.
- `Scheduled` Price schedule with special prices; while active, its lowest applicable price takes precedence over standard price lists.

Types several repositories share, such as `PageInfo` and the filter fields, are in the [types index](https://developers.coevera.com/reference/graphql/types.md). The [SDL](https://developers.coevera.com/graphql/schema.graphql) has the whole schema in one file.

## Example

```graphql
query FirstProductPriceLists {
  entities {
    productPriceList {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id name modified } }
      }
    }
  }
}
```

```bash
curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstProductPriceLists { entities { productPriceList { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}'
```