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

# entities.opptyProductRelationType

Read oppty product relation type records with the opptyProductRelationType repository, and change them with the oppty product relation type mutations. Same records as the REST OpptyProductRelationTypes entity.

REST: [OpptyProductRelationTypes](https://developers.coevera.com/reference/rest/oppty-product-relation-types.md).

## Queries

- `getById(entityId: ID!): OpptyProductRelationTypeEntity` Returns the record with the given id, or null when there is none. Deleted records are returned as well.
- `getByIds(entityIds: [ID!]!): [OpptyProductRelationTypeEntity!]!` 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: OpptyProductRelationTypeFilterInput, orderBy: [OpptyProductRelationTypeOrderByInput!], includeDeleted: Boolean): [OpptyProductRelationTypeEntity!]!` Returns the records that match the filter, paged with limit and offset.
- `getByCriteria(filter: OpptyProductRelationTypeFilterInput, orderBy: [OpptyProductRelationTypeOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int): OpptyProductRelationTypeEntityConnection` Returns the records that match the filter as a cursor-paginated connection.
- `getPublished(limit: Int, offset: Int, filter: OpptyProductRelationTypeFilterInput, orderBy: [OpptyProductRelationTypeOrderByInput!], includeDeleted: Boolean): [OpptyProductRelationTypeEntity!]!` Returns the published records that match the filter, paged with limit and offset.
- `getDrafts(filter: OpptyProductRelationTypeFilterInput, orderBy: [OpptyProductRelationTypeOrderByInput!]): [OpptyProductRelationTypeEntity!]!` Returns the records that match the filter, with pending unpublished changes applied where a draft exists.
- `getDraftById(entityId: ID!): OpptyProductRelationTypeEntity!` Returns the record with the given id, with its pending unpublished changes applied when a draft exists.

## Types

### OpptyProductRelationTypeEntity (object)

Line-item type that defines the form of product line items on opportunities and quotes; paired with a product type.

- `hasDraft: Boolean` True when the record has unpublished draft changes, including pending translation changes, that can be published.
- `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.
- `formEditApi: Form` Typed, read-only view of a form layout of this type: formEditApi mirrors the edit form (formEdit), formLostApi the form shown when archiving as lost (formLost).
- `canChangeReadonly: Boolean` False for types whose read-only setting is fixed, such as the recurrent appointment type; true otherwise.
- `id: ID!` Unique identifier of entity.
- `isDeleted: Boolean` Specifies if the entity is considered deleted.
- `modified: DateTime` Last modification time.
- `created: DateTime` Creation time.
- `formEdit: JSONString!` JSON definition of the form layout used by the UI when adding line items of this type to opportunities or quotes. This payload conforms to the `Form` JSON Schema: GET /api/v100/rest/schemas/Form.json on your region's API host
- `isReadonly: Boolean!` True when the line-item type is system-managed and cannot be edited or deleted by users.
- `name: String!` Name of the entity and its default text representation.
- `isPublished: Boolean` True when the entity configuration is published; false while it exists only as an unpublished draft.
- `revision: Int` Revision when entity was lastly changed.
- `productType: ProductTypeEntity` Product type paired with this line-item type.
- `productTypeId: UUID!` Id of the paired product type. Read-only.
- `instancePermissions: [EntityPermsEnum!]! (1 args)` Permissions the current user has on this record, out of the requested ones.

### OpptyProductRelationTypeEntityConnection (object)

Paginated list of OpptyProductRelationType records.

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

### OpptyProductRelationTypeEntityEdge (object)

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

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

### OpptyProductRelationTypeFilterInput (input)

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

- `OR: [OpptyProductRelationTypeFilterInput!]` Matches records that meet at least one of the listed filters.
- `AND: [OpptyProductRelationTypeFilterInput!]` Matches records that meet all of the listed filters.
- `NOT: OpptyProductRelationTypeFilterInput` 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.
- `isReadonly: Boolean` True when the line-item type is system-managed and cannot be edited or deleted by users.
- `name: EntityFilterStringField` Name of the entity and its default text representation.
- `isPublished: Boolean` True when the entity configuration is published; false while it exists only as an unpublished draft.
- `revision: EntityFilterNumberField` Revision when entity was lastly changed.
- `productType: ProductTypeFilterInput` Product type paired with this line-item type. Matches records where a related record meets these conditions.

### OpptyProductRelationTypeOrderByInput (input)

Sorting of OpptyProductRelationType 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.
- `isReadonly: OrderByEnum` True when the line-item type is system-managed and cannot be edited or deleted by users.
- `name: OrderByEnum` Name of the entity and its default text representation.
- `isPublished: OrderByEnum` True when the entity configuration is published; false while it exists only as an unpublished draft.
- `revision: OrderByEnum` Revision when entity was lastly changed.
- `productType: [ProductTypeOrderByNestedInput!]` Product type paired with this line-item type. Sorts by fields of the related record, listed in order of priority.

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