GraphQL RepositoriesproductPriceListPrice

`entities.productPriceListPrice`

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

Example: first three product price list price recordsGraphQLcURL

query FirstProductPriceListPrices {
  entities {
    productPriceListPrice {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

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 FirstProductPriceListPrices { entities { productPriceListPrice { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { productPriceListPrice { … } }.

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

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createProductPriceListPrice`(input: CreateProductPriceListPriceInput!, validationLevel: [ValidationLevel!])	Create one record	CreateProductPriceListPricePayload
MUTATION	`updateProductPriceListPrice`(input: UpdateProductPriceListPriceInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateProductPriceListPricePayload
MUTATION	`bulkUpdateProductPriceListPrice`(input: [CreateOrUpdateProductPriceListPriceInput!]!, deleteInput: [DeleteProductPriceListPriceInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput, action: UpdateProductPriceListActionEnum)	Create or update many; per-item results	BulkUpdateProductPriceListPricePayload
MUTATION	`deleteProductPriceListPrice`(input: DeleteProductPriceListPriceInput!)	Soft-delete	DeleteProductPriceListPricePayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

ProductPriceListPriceEntity object 15 fields: isDeleteProtected, id, isDeleted, …

Price of a product in one currency within a price list.

Field	Type	Description
`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.
`currency`	CurrencyEntity	Currency the price value is denominated in.
`product`	ProductEntity	Product the price applies to.
`productPriceList`	ProductPriceListEntity	Price list the price belongs to.
`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.
`productPriceListId`	ID!	Id of the price list this price belongs to.
`settings`	ProductPriceListPriceSettings!	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.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

ProductPriceListPriceEntityConnection object pageInfo: PageInfo!, edges: [ProductPriceListPriceEntityEdge]!, totalCount: Int

Paginated list of ProductPriceListPrice records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[ProductPriceListPriceEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

ProductPriceListPriceEntityEdge object node: ProductPriceListPriceEntity, cursor: String!

A Relay edge containing a ProductPriceListPriceEntity and its cursor.

Field	Type	Description
`node`	ProductPriceListPriceEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

ProductPriceListPriceFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

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

Input field	Type	Description
`OR`	[ProductPriceListPriceFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ProductPriceListPriceFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ProductPriceListPriceFilterInput	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.
`currencyId`	EntityFilterStringField	Id of the currency the price is denominated in.
`price`	EntityFilterNumberField	Price amount stored at 6-decimal precision; values set via the API are rounded.
`productId`	EntityFilterStringField	Id of the product the price applies to.
`productPriceListId`	EntityFilterStringField	Id of the price list this price belongs to.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`currency`	CurrencyFilterInput	Currency the price value is denominated in. Matches records where a related record meets these conditions.
`product`	ProductFilterInput	Product the price applies to. Matches records where a related record meets these conditions.
`productPriceList`	ProductPriceListFilterInput	Price list the price belongs to. Matches records where a related record meets these conditions.

ProductPriceListPriceOrderByInput input Asc or Desc per field

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

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`currency`	[CurrencyOrderByNestedInput!]	Currency the price value is denominated in. Sorts by fields of the related record, listed in order of priority.
`product`	[ProductOrderByNestedInput!]	Product the price applies to. Sorts by fields of the related record, listed in order of priority.
`productPriceList`	[ProductPriceListOrderByNestedInput!]	Price list the price belongs to. Sorts by fields of the related record, listed in order of priority.
`currencyId`	OrderByEnum	Id of the currency the price is denominated in.
`price`	OrderByEnum	Price amount stored at 6-decimal precision; values set via the API are rounded.
`productId`	OrderByEnum	Id of the product the price applies to.
`productPriceListId`	OrderByEnum	Id of the price list this price belongs to.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateOrUpdateProductPriceListPriceInput input 10 fields: clientMutationId, id, modified, …

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

Input field	Type	Description
`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.
`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.
`productPriceListId`	ID	Id of the price list this price belongs 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.

CreateProductPriceListPriceInput input 9 fields: clientMutationId, modified, created, …

Field values of a new ProductPriceListPrice record.

Input field	Type	Description
`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.
`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.
`productPriceListId`	ID!	Id of the price list this price belongs 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.

DeleteProductPriceListPriceInput input clientMutationId: String, id: ID!

Id of the ProductPriceListPrice record to delete.

Input field	Type	Description
`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.

UpdateProductPriceListPriceInput input 10 fields: clientMutationId, id, modified, …

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

Input field	Type	Description
`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.
`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.
`productPriceListId`	ID	Id of the price list this price belongs 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.

BulkUpdateProductPriceListPricePayload object result: BulkUpdateResults!

Result of the bulkUpdateProductPriceListPrice mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateProductPriceListPricePayload object productPriceListPrice: ProductPriceListPriceEntity, clientMutationId: String

Result of the createProductPriceListPrice mutation.

Field	Type	Description
`productPriceListPrice`	ProductPriceListPriceEntity	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).

DeleteProductPriceListPricePayload object productPriceListPrice: ProductPriceListPriceEntity, clientMutationId: String

Result of the deleteProductPriceListPrice mutation.

Field	Type	Description
`productPriceListPrice`	ProductPriceListPriceEntity	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).

UpdateProductPriceListPricePayload object productPriceListPrice: ProductPriceListPriceEntity, clientMutationId: String

Result of the updateProductPriceListPrice mutation.

Field	Type	Description
`productPriceListPrice`	ProductPriceListPriceEntity	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).

ProductPriceListPriceAccessEnum enum NoAccess, All, Role

Who can change the price taken from a price list when the product is added to a record.

Value	Description
`NoAccess`	Nobody can change the price.
`All`	All users can change the price.
`Role`	Only users whose role is listed in accessRoles can change the price.

ProductPriceListPriceSettings object access: ProductPriceListPriceAccessEnum!, accessRoles: [UUID!]

Who can change a price list price of a product on the product lines of opportunities and quotes.

Field	Type	Description
`access`	ProductPriceListPriceAccessEnum!	Who can change this price on a product line of an opportunity or quote: nobody (NoAccess), all users (All) or only users with a role in accessRoles (Role).
`accessRoles`	[UUID!]	Ids of the user roles allowed to change the price. Effective only when access is Role.