Developers
Set your API contextPick a region and space ID once. Every sample fills in your base URL.
Where do I find these?

In Coevera: open your space's API application and choose Show Access. It shows the space ID and the base URL, whose host starts with your region.

From the API: if you know the space ID, the discovery endpoint GET /api/discovery/spaces/{space_id} returns its region and base URLs, without credentials.

Only the region and space ID are kept, in this browser. Never paste a key or password here.

More in the quickstart

GraphQLRepositoriesopptyProductRelation

entities.opptyProductRelation

Read oppty product relation records with the opptyProductRelation repository, and change them with the oppty product relation mutations. Same records as the REST OpptyProductRelations entity.

Queries

Fields of entities { opptyProductRelation { … } }.

KindFieldReturns
QUERYgetById(entityId: ID!)
Returns the record with the given id, or null when there is none. Deleted records are returned as well.
OpptyProductRelationEntity
QUERYgetByIds(entityIds: [ID!]!)
Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.
[OpptyProductRelationEntity!]!
QUERYgetAll(limit: Int, offset: Int, filter: OpptyProductRelationFilterInput, orderBy: [OpptyProductRelationOrderByInput!], includeDeleted: Boolean)
Returns the records that match the filter, paged with limit and offset.
[OpptyProductRelationEntity!]!
QUERYgetByCriteria(filter: OpptyProductRelationFilterInput, orderBy: [OpptyProductRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int)
Returns the records that match the filter as a cursor-paginated connection.
OpptyProductRelationEntityConnection
QUERYgetChangedFieldsSinceRevision(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!]!
QUERYgetBySession(includedIds: [UUID!]!, excludedIds: [UUID!]!, sessionId: String!, before: String, after: String, first: Int, last: Int)
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.
OpptyProductRelationEntityConnection
QUERYgetByIdFormatted(id: UUID!, fieldIds: [UUID!])
Returns the values of a record's fields formatted for display, keyed by field id.
JSONString

Mutations

KindMutationDoesReturns
MUTATIONcreateOpptyProductRelation(input: CreateOpptyProductRelationInput!, validationLevel: [ValidationLevel!])Create one recordCreateOpptyProductRelationPayload
MUTATIONupdateOpptyProductRelation(input: UpdateOpptyProductRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)Update fieldsUpdateOpptyProductRelationPayload
MUTATIONbulkUpdateOpptyProductRelation(input: [CreateOrUpdateOpptyProductRelationInput!]!, deleteInput: [DeleteOpptyProductRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)Create or update many; per-item resultsBulkUpdateOpptyProductRelationPayload
MUTATIONdeleteOpptyProductRelation(input: DeleteOpptyProductRelationInput!)Soft-deleteDeleteOpptyProductRelationPayload

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.

OpptyProductRelationEntity object 34 fields: customFields, isDeleteProtected, id, …

Product line item on an opportunity or quote, with its quantity, price and discount.

FieldTypeDescription
customFieldsJSONString! (1 args)Values of the record's custom fields as a JSON object keyed by custom field apiName (camelCase).
isDeleteProtectedBoolean!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.
idID!Unique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
currencyExchangeRatesListCurrencyExchangeRatesListEntityCurrency exchange rate list used to convert this line item, inherited from the parent opportunity or quote.
onlineFormFieldFieldEntityOnline form field that produced this line item, or empty when not applicable.
onlineFormOnlineFormEntityOnline form this line item came from when the related opportunity was created through a form submission, or empty otherwise.
opptyOpportunityEntityOpportunity this line item belongs to. Set on create; mutually exclusive with quote.
opptyProductRelationTypeOpptyProductRelationTypeEntityLine-item type that drives the form layout for this product line. Resolved from the product type on create.
pairedOpptyProductRelationOpptyProductRelationEntityCounterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing.
productProductEntityProduct on this line item. Set on create; cannot be changed afterwards.
quoteQuoteEntityQuote this line item belongs to. Set on create; mutually exclusive with opportunity.
amountFloatTotal amount of the line item (price * quantity, with discounts applied).
commentStringFree-form note describing this line item.
currencyExchangeRatesListIdIDId of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote.
onlineFormFieldIdIDId of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission.
onlineFormIdIDId of the online form submission this line item came from, or empty when it was not created through a form.
opptyIdIDId of the opportunity.
opptyProductRelationTypeIdIDId of the line-item type.
pairedOpptyProductRelationIdIDId of the paired line item.
priceFloatPer-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly.
productIdID!Id of the product on this line item. Set on create; cannot be changed afterwards.
quantityFloatNumber of product units on this line item.
quoteIdIDId of the quote this line item belongs to. Mutually exclusive with opptyId.
sectionIdIDIdentifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote).
sortOrderIntDisplay order of the line item within its section. Maintained automatically when lines are added or moved.
revisionIntRevision when entity was lastly changed.
revenueScheduleOpptyProductRelationRevenueScheduleEntityPer-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level.
discountValueFloatAbsolute monetary discount applied to this line item versus the price-list price. Read-only; computed by Coevera.
discountPercentageFloatPercentage discount applied to this line item versus the price-list price. Read-only; computed by Coevera.
modifiedByUserDateTimeTimestamp of the most recent modification made by an end user (excluding system changes). Read-only; computed by Coevera.
instancePermissions[EntityPermsEnum!]! (1 args)Permissions the current user has on this record, out of the requested ones.
OpptyProductRelationEntityConnection object pageInfo: PageInfo!, edges: [OpptyProductRelationEntityEdge]!, totalCount: Int

Paginated list of OpptyProductRelation records.

FieldTypeDescription
pageInfoPageInfo!Pagination data for this connection.
edges[OpptyProductRelationEntityEdge]!Contains the nodes in this connection.
totalCountIntTotal number of items in the connection.
OpptyProductRelationEntityEdge object node: OpptyProductRelationEntity, cursor: String!

A Relay edge containing a OpptyProductRelationEntity and its cursor.

FieldTypeDescription
nodeOpptyProductRelationEntityThe item at the end of the edge
cursorString!A cursor for use in pagination
OpptyProductRelationFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

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

Input fieldTypeDescription
OR[OpptyProductRelationFilterInput!]Matches records that meet at least one of the listed filters.
AND[OpptyProductRelationFilterInput!]Matches records that meet all of the listed filters.
NOTOpptyProductRelationFilterInputMatches records that do not meet this filter.
globalSearchQueryStringSearch term matched against the fields that the global search covers for this entity.
idEntityFilterStringFieldUnique identifier of entity.
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedEntityFilterDateTimeFieldLast modification time.
createdEntityFilterDateTimeFieldCreation time.
amountEntityFilterNumberFieldTotal amount of the line item (price * quantity, with discounts applied).
commentEntityFilterStringFieldFree-form note describing this line item.
currencyExchangeRatesListIdEntityFilterStringFieldId of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote.
onlineFormFieldIdEntityFilterStringFieldId of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission.
onlineFormIdEntityFilterStringFieldId of the online form submission this line item came from, or empty when it was not created through a form.
opptyIdEntityFilterStringFieldId of the opportunity.
opptyProductRelationTypeIdEntityFilterStringFieldId of the line-item type.
pairedOpptyProductRelationIdEntityFilterStringFieldId of the paired line item.
priceEntityFilterNumberFieldPer-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly.
productIdEntityFilterStringFieldId of the product on this line item. Set on create; cannot be changed afterwards.
quantityEntityFilterNumberFieldNumber of product units on this line item.
quoteIdEntityFilterStringFieldId of the quote this line item belongs to. Mutually exclusive with opptyId.
sectionIdEntityFilterStringFieldIdentifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote).
sortOrderEntityFilterNumberFieldDisplay order of the line item within its section. Maintained automatically when lines are added or moved.
revisionEntityFilterNumberFieldRevision when entity was lastly changed.
discountValueFloatAbsolute monetary discount applied to this line item versus the price-list price. Read-only; computed by Coevera.
discountPercentageFloatPercentage discount applied to this line item versus the price-list price. Read-only; computed by Coevera.
withCustom[CustomField!]Conditions on custom fields, each identified by its api name. All listed conditions must match.
currencyExchangeRatesListCurrencyExchangeRatesListFilterInputCurrency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. Matches records where a related record meets these conditions.
onlineFormFieldFieldFilterInputOnline form field that produced this line item, or empty when not applicable. Matches records where a related record meets these conditions.
onlineFormOnlineFormFilterInputOnline form this line item came from when the related opportunity was created through a form submission, or empty otherwise. Matches records where a related record meets these conditions.
opptyOpportunityFilterInputOpportunity this line item belongs to. Set on create; mutually exclusive with quote. Matches records where a related record meets these conditions.
opptyProductRelationTypeOpptyProductRelationTypeFilterInputLine-item type that drives the form layout for this product line. Resolved from the product type on create. Matches records where a related record meets these conditions.
pairedOpptyProductRelationOpptyProductRelationFilterInputCounterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing. Matches records where a related record meets these conditions.
productProductFilterInputProduct on this line item. Set on create; cannot be changed afterwards. Matches records where a related record meets these conditions.
quoteQuoteFilterInputQuote this line item belongs to. Set on create; mutually exclusive with opportunity. Matches records where a related record meets these conditions.
revenueScheduleOpptyProductRelationRevenueScheduleFilterInputPer-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level. Matches records where a related record meets these conditions.
OpptyProductRelationOrderByInput input Asc or Desc per field

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

Input fieldTypeDescription
idOrderByEnumUnique identifier of entity.
isDeletedOrderByEnumSpecifies if the entity is considered deleted.
modifiedOrderByEnumLast modification time.
createdOrderByEnumCreation time.
currencyExchangeRatesList[CurrencyExchangeRatesListOrderByNestedInput!]Currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. Sorts by fields of the related record, listed in order of priority.
onlineFormField[FieldOrderByNestedInput!]Online form field that produced this line item, or empty when not applicable. Sorts by fields of the related record, listed in order of priority.
onlineForm[OnlineFormOrderByNestedInput!]Online form this line item came from when the related opportunity was created through a form submission, or empty otherwise. Sorts by fields of the related record, listed in order of priority.
oppty[OpportunityOrderByNestedInput!]Opportunity this line item belongs to. Set on create; mutually exclusive with quote. Sorts by fields of the related record, listed in order of priority.
opptyProductRelationType[OpptyProductRelationTypeOrderByNestedInput!]Line-item type that drives the form layout for this product line. Resolved from the product type on create. Sorts by fields of the related record, listed in order of priority.
pairedOpptyProductRelation[OpptyProductRelationOrderByNestedInput!]Counterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing. Sorts by fields of the related record, listed in order of priority.
product[ProductOrderByNestedInput!]Product on this line item. Set on create; cannot be changed afterwards. Sorts by fields of the related record, listed in order of priority.
quote[QuoteOrderByNestedInput!]Quote this line item belongs to. Set on create; mutually exclusive with opportunity. Sorts by fields of the related record, listed in order of priority.
amountOrderByEnumTotal amount of the line item (price * quantity, with discounts applied).
commentOrderByEnumFree-form note describing this line item.
currencyExchangeRatesListIdOrderByEnumId of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote.
onlineFormFieldIdOrderByEnumId of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission.
onlineFormIdOrderByEnumId of the online form submission this line item came from, or empty when it was not created through a form.
opptyIdOrderByEnumId of the opportunity.
opptyProductRelationTypeIdOrderByEnumId of the line-item type.
pairedOpptyProductRelationIdOrderByEnumId of the paired line item.
priceOrderByEnumPer-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly.
productIdOrderByEnumId of the product on this line item. Set on create; cannot be changed afterwards.
quantityOrderByEnumNumber of product units on this line item.
quoteIdOrderByEnumId of the quote this line item belongs to. Mutually exclusive with opptyId.
sortOrderOrderByEnumDisplay order of the line item within its section. Maintained automatically when lines are added or moved.
revisionOrderByEnumRevision when entity was lastly changed.
revenueSchedule[OpptyProductRelationRevenueScheduleOrderByNestedInput!]Per-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level. Sorts by fields of the related record, listed in order of priority.
discountValueOrderByEnumAbsolute monetary discount applied to this line item versus the price-list price. Read-only; computed by Coevera.
discountPercentageOrderByEnumPercentage discount applied to this line item versus the price-list price. Read-only; computed by Coevera.
withCustomCommonEntityRepositoryOrderByCustomFieldSorts by a custom field.
CreateOpptyProductRelationInput input 21 fields: clientMutationId, modified, created, …

Field values of a new OpptyProductRelation record.

Input fieldTypeDescription
clientMutationIdStringOptional 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).
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
pairedOpptyProductRelationCreateOpptyProductRelationInputCounterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing.
amountFloatTotal amount of the line item (price * quantity, with discounts applied).
commentStringFree-form note describing this line item.
currencyExchangeRatesListIdIDId of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote.
onlineFormFieldIdIDId of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission.
onlineFormIdIDId of the online form submission this line item came from, or empty when it was not created through a form.
opptyIdIDId of the opportunity.
opptyProductRelationTypeIdIDId of the line-item type.
pairedOpptyProductRelationIdIDId of the paired line item.
priceFloatPer-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly.
productIdID!Id of the product on this line item. Set on create; cannot be changed afterwards.
quantityFloatNumber of product units on this line item.
quoteIdIDId of the quote this line item belongs to. Mutually exclusive with opptyId.
sectionIdIDIdentifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote).
sortOrderIntDisplay order of the line item within its section. Maintained automatically when lines are added or moved.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
revenueScheduleCreateOpptyProductRelationRevenueScheduleNoIdBackrefInputPer-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level.
CreateOpptyProductRelationRevenueScheduleNoIdBackrefInput input 8 fields: isDeleted, modified, created, …

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

Input fieldTypeDescription
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
cancelationDateDateDate when the revenue schedule was cancelled. Empty for active schedules.
periodCountIntNumber of periods the line-item amount is split into.
periodTypeRevenueSchedulePeriodTypeEnumLength of each period (e.g. Monthly, Quarterly, Yearly).
startDateDateDate when revenue recognition for this product line begins.
revisionIntRevision when entity was lastly changed.
CreateOrUpdateOpptyProductRelationInput input 22 fields: clientMutationId, id, modified, …

Field values of an OpptyProductRelation record to create, or to update when its id is set.

Input fieldTypeDescription
clientMutationIdStringOptional 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).
idIDUnique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
pairedOpptyProductRelationCreateOpptyProductRelationInputCounterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing.
amountFloatTotal amount of the line item (price * quantity, with discounts applied).
commentStringFree-form note describing this line item.
currencyExchangeRatesListIdIDId of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote.
onlineFormFieldIdIDId of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission.
onlineFormIdIDId of the online form submission this line item came from, or empty when it was not created through a form.
opptyIdIDId of the opportunity.
opptyProductRelationTypeIdIDId of the line-item type.
pairedOpptyProductRelationIdIDId of the paired line item.
priceFloatPer-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly.
productIdIDId of the product on this line item. Set on create; cannot be changed afterwards.
quantityFloatNumber of product units on this line item.
quoteIdIDId of the quote this line item belongs to. Mutually exclusive with opptyId.
sectionIdIDIdentifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote).
sortOrderIntDisplay order of the line item within its section. Maintained automatically when lines are added or moved.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
revenueScheduleUpdateOpptyProductRelationRevenueScheduleNoIdBackrefInputPer-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level.
DeleteOpptyProductRelationInput input clientMutationId: String, id: ID!

Id of the OpptyProductRelation record to delete.

Input fieldTypeDescription
clientMutationIdStringOptional 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).
idID!Unique identifier of entity.
UpdateOpptyProductRelationInput input 21 fields: clientMutationId, id, modified, …

Id of an OpptyProductRelation record and the field values to change.

Input fieldTypeDescription
clientMutationIdStringOptional 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).
idID!Unique identifier of entity.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
pairedOpptyProductRelationCreateOpptyProductRelationInputCounterpart line item on the paired record (e.g. matching line on the active quote when this line is on the opportunity, or vice versa). Empty when there is no pairing.
amountFloatTotal amount of the line item (price * quantity, with discounts applied).
commentStringFree-form note describing this line item.
currencyExchangeRatesListIdIDId of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote.
onlineFormFieldIdIDId of the online form field in which the respondent selected this product, or empty when the line item did not come from a form submission.
onlineFormIdIDId of the online form submission this line item came from, or empty when it was not created through a form.
opptyIdIDId of the opportunity.
opptyProductRelationTypeIdIDId of the line-item type.
pairedOpptyProductRelationIdIDId of the paired line item.
priceFloatPer-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly.
quantityFloatNumber of product units on this line item.
quoteIdIDId of the quote this line item belongs to. Mutually exclusive with opptyId.
sectionIdIDIdentifier of the product section this line belongs to (see the productSections JSON layout on the parent opportunity or quote).
sortOrderIntDisplay order of the line item within its section. Maintained automatically when lines are added or moved.
customFieldsJSONStringCustom field values to set, as a JSON object keyed by custom field API name, e.g. {"cfBudget": 1000}. Only the custom fields included are changed; each value uses the format of that field.
revisionIntRevision when entity was lastly changed.
revenueScheduleUpdateOpptyProductRelationRevenueScheduleNoIdBackrefInputPer-line revenue schedule splitting the line amount across periods. Available only when revenue scheduling is configured at product-amount level.
UpdateOpptyProductRelationRevenueScheduleNoIdBackrefInput input 8 fields: isDeleted, modified, created, …

Id of an OpptyProductRelationRevenueSchedule record and the field values to change, updated together with the record it belongs to.

Input fieldTypeDescription
isDeletedBooleanSpecifies if the entity is considered deleted.
modifiedDateTimeLast modification time.
createdDateTimeCreation time.
cancelationDateDateDate when the revenue schedule was cancelled. Empty for active schedules.
periodCountIntNumber of periods the line-item amount is split into.
periodTypeRevenueSchedulePeriodTypeEnumLength of each period (e.g. Monthly, Quarterly, Yearly).
startDateDateDate when revenue recognition for this product line begins.
revisionIntRevision when entity was lastly changed.
BulkUpdateOpptyProductRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateOpptyProductRelation mutation.

FieldTypeDescription
resultBulkUpdateResults!Ids of the created, updated and deleted records, and the items that failed.
CreateOpptyProductRelationPayload object opptyProductRelation: OpptyProductRelationEntity, clientMutationId: String

Result of the createOpptyProductRelation mutation.

FieldTypeDescription
opptyProductRelationOpptyProductRelationEntityThe created record.
clientMutationIdStringOptional 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).
DeleteOpptyProductRelationPayload object opptyProductRelation: OpptyProductRelationEntity, clientMutationId: String

Result of the deleteOpptyProductRelation mutation.

FieldTypeDescription
opptyProductRelationOpptyProductRelationEntityThe deleted record.
clientMutationIdStringOptional 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).
UpdateOpptyProductRelationPayload object opptyProductRelation: OpptyProductRelationEntity, clientMutationId: String

Result of the updateOpptyProductRelation mutation.

FieldTypeDescription
opptyProductRelationOpptyProductRelationEntityThe updated record.
clientMutationIdStringOptional 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).