OBJECT
ProductRepository
Read operations for Product records.
link GraphQL Schema definition
- type ProductRepository {
- # Returns the record with the given id, or null when there is none. Deleted
- # records are returned as well.
- #
- # Arguments
- # entityId: Id of the record to return.
- (: ID!): ProductEntity
- # Returns the records with the given ids; ids without a record are left out.
- # Deleted records are returned as well.
- #
- # Arguments
- # entityIds: Ids of the records to return.
- (: [ID!]!): [ProductEntity!]!
- # Returns the records that match the filter, paged with limit and offset.
- #
- # Arguments
- # limit: Maximum number of records to return.
- # offset: Number of records to skip from the start of the result.
- # filter: Conditions the returned records must meet.
- # orderBy: Sorting of the returned records.
- # includeDeleted: When true, deleted records are returned as
- # well. Defaults to false.
- (
- : Int,
- : Int,
- : ProductFilterInput,
- : [ProductOrderByInput!],
- : Boolean
- ): [ProductEntity!]!
- # Returns the products that match the filter as a cursor-paginated connection.
- #
- # Arguments
- # filter: Conditions the returned records must meet.
- # orderBy: Sorting of the returned records.
- # includeDeleted: When true, deleted records are returned as
- # well. Defaults to false.
- # priceListId: When set, returns only products that have a price
- # in this price list.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : ProductFilterInput,
- : [ProductOrderByInput!],
- : Boolean,
- : ID,
- : String,
- : String,
- : Int,
- : Int
- ): ProductEntityConnection
- # Returns the ids of the fields of a record that changed after the given revision.
- # Returns an empty list for entities without change tracking.
- #
- # Arguments
- # id: Id of the record.
- # revision: Revision to compare against; only later changes are
- # returned.
- (
- : UUID!,
- : Int!
- ): [UUID!]!
- # Returns a page of records selected in a list or report: all records of the given
- # result plus the explicitly included ids, minus the excluded ids.
- #
- # Arguments
- # includedIds: Ids of records to add to the selection.
- # excludedIds: Ids of records to remove from the selection.
- # sessionId: Id of the list or report result to take the records
- # from. Pass an empty string to select only the included ids.
- # before: Cursor until which to take entities to result set.
- # after: Cursor after which to start taking entities to result
- # set.
- # first: Number of entities to return from beginning of the
- # result set.
- # last: Return only the "last" number of entities from result
- # set.
- (
- : [UUID!]!,
- : [UUID!]!,
- : String!,
- : String,
- : String,
- : Int,
- : Int
- ): ProductEntityConnection
- # Returns the values of a record's fields formatted for display, keyed by field
- # id.
- #
- # Arguments
- # id: Id of the record.
- # fieldIds: Ids of the fields to return; null returns all fields.
- (: UUID!, : [UUID!]): JSONString
- # Returns the products that can be used in the given pipeline: products allowed in
- # all pipelines and products assigned to this pipeline.
- #
- # Arguments
- # pipelineId: Id of the pipeline; an error is returned when it
- # does not exist.
- # limit: Maximum number of records to return.
- # offset: Number of records to skip from the start of the result.
- # filter: Conditions the returned records must meet.
- # orderBy: Sorting of the returned records.
- (
- : UUID!,
- : Int,
- : Int,
- : ProductFilterInput,
- : [ProductOrderByInput!]
- ): [ProductEntity!]!
- }