---
title: OpptyProductRelations
description: "OpptyProductRelations: list, get, create, update and delete, plus batch operations."
canonical: https://developers.coevera.com/reference/rest/oppty-product-relations/
section: rest
verification: schema
generatedFrom: spec 5e43371 (2026-10-16)
publisher: Coevera
---

# OpptyProductRelations

OpptyProductRelations: list, get, create, update and delete, plus batch operations.

Family: Products, pricing, quotes and currencies. GraphQL: [opptyProductRelation](https://developers.coevera.com/reference/graphql/oppty-product-relation.md). Base URL: `https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}`.

| Method | Path | Operation |
| --- | --- | --- |
| GET | `/entities/OpptyProductRelations` | List OpptyProductRelations |
| POST | `/entities/OpptyProductRelations` | Create OpptyProductRelation |
| GET | `/entities/OpptyProductRelations/{id}` | Get OpptyProductRelation |
| PATCH | `/entities/OpptyProductRelations/{id}` | Update OpptyProductRelation |
| DELETE | `/entities/OpptyProductRelations/{id}` | Delete OpptyProductRelation |
| POST | `/entities/OpptyProductRelations/batch-modify` | Create or update OpptyProductRelations in a batch |
| POST | `/entities/OpptyProductRelations/batch-delete` | Delete OpptyProductRelations in a batch |
| POST | `/entities/OpptyProductRelations/batch-restore` | Restore deleted OpptyProductRelations |

## List OpptyProductRelations

`GET /entities/OpptyProductRelations`

Returns the OpptyProductRelations the API application can read, one page at a time. In the list envelope, `total` counts every match and `page_info` pages through them.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `include-deleted` | query | boolean | Include soft-deleted records. Lists only; get-by-id refuses it. |
| `first` | query | integer | Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117. (default 30, 1 to 100) |
| `last` | query | integer | Return the last N records of the result; together with `first`, the last N of the first M. Maximum 100. (1 to 100) |
| `before` | query | string | Cursor from `page_info.start_cursor`, to page backwards. URL-encode it. |
| `after` | query | string | Cursor from `page_info.end_cursor` of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space. |
| `expand` | query | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in `account_relations.account`. |
| `order-by` | query | string | Fields to sort by, comma-separated. A leading - sorts descending, as in `-modified`; dotted paths sort by related fields. |
| `filter` | query | object | `filter[field]=value`. Separate several values with a raw comma (OR), as in `filter[name]=north,south`. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in `filter[owner.email]`. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space. |
| `filter-op` | query | object | `filter-op[field]=operator`, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one. |
| `load-only` | query | string | Fields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in `owner.id`. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118. |

Responses: 200 (Page of OpptyProductRelation records.: `success`, `total`, `page_info`, `data`), 400, 401, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OpptyProductRelations?first=10' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Create OpptyProductRelation

`POST /entities/OpptyProductRelations`

Creates one record and answers 201 with it.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `validation-level` | query | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |

Request body: The new record's fields. Relations are set by id. Schema `createOpptyProductRelationInput`. Required: `product_id`.

Responses: 201 (The created OpptyProductRelation record.: `success`, `data`), 400, 401, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OpptyProductRelations' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "product_id": "ad000000-0000-4000-a000-000000000001"
}'
```

## Get OpptyProductRelation

`GET /entities/OpptyProductRelations/{id}`

Returns one record by id. `expand` returns related records inline instead of their URIs.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the OpptyProductRelation record to retrieve. |
| `expand` | query | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts. |

Responses: 200 (The OpptyProductRelation record.: `success`, `data`), 400, 401, 404, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OpptyProductRelations/b1000000-0000-4000-a000-000000000001' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Update OpptyProductRelation

`PATCH /entities/OpptyProductRelations/{id}`

Changes the fields you send and leaves the rest as they are; there is no PUT.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the OpptyProductRelation record to update. |
| `validation-level` | query | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |

Request body: The fields to change. Schema `updateOpptyProductRelationInput`.

Responses: 200 (The changed OpptyProductRelation record.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OpptyProductRelations/b1000000-0000-4000-a000-000000000001' \
  --request PATCH \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "paired_oppty_product_relation": {}
}'
```

## Delete OpptyProductRelation

`DELETE /entities/OpptyProductRelations/{id}`

Deletes one record and answers with its id.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the OpptyProductRelation record to delete. |

Responses: 200 (Deletion confirmation.: `success`, `data`), 400, 401, 404, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OpptyProductRelations/b1000000-0000-4000-a000-000000000001' \
  --request DELETE \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"
```

## Create or update OpptyProductRelations in a batch

`POST /entities/OpptyProductRelations/batch-modify`

An item with an `id` updates that record; an item without one creates a record. By default one invalid item fails the whole call with HTTP 422 and nothing is written; with `rollback-method=1` the response has an id or an error for each item, in input order.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `validation-level` | query | integer | Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117. |
| `rollback-method` | query | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. (default 0) |

Request body: A JSON array of records: an item with an `id` updates, an item without one creates. Schema `batchOpptyProductRelationInput`. Required: `product_id`.

Responses: 200 (Result per item, in request order: the id of the created or updated record, or the error.: `success`, `data`), 400, 401, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OpptyProductRelations/batch-modify' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "product_id": "ad000000-0000-4000-a000-000000000001"
  },
  {
    "id": "b1000000-0000-4000-a000-000000000001",
    "paired_oppty_product_relation": {}
  }
]'
```

## Delete OpptyProductRelations in a batch

`POST /entities/OpptyProductRelations/batch-delete`

Deletes the records whose ids are in the body, a JSON array. By default an unknown id fails the whole call with HTTP 404.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `rollback-method` | query | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. (default 0) |

Request body: A JSON array of ids.

Responses: 200 (Result per id, in request order: the id of the deleted record, or the error.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OpptyProductRelations/batch-delete' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "b1000000-0000-4000-a000-000000000001",
  "b1000000-0000-4000-a000-000000000002"
]'
```

## Restore deleted OpptyProductRelations

`POST /entities/OpptyProductRelations/batch-restore`

Restores the deleted records whose ids are in the body, a JSON array.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `rollback-method` | query | integer | 0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item. (default 0) |

Request body: A JSON array of ids.

Responses: 200 (Result per id, in request order: the id of the restored record, or the error.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/OpptyProductRelations/batch-restore' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "b1000000-0000-4000-a000-000000000001",
  "b1000000-0000-4000-a000-000000000002"
]'
```

## OpptyProductRelation fields

| Field | Type | Notes |
| --- | --- | --- |
| `id` | uuid | Read-only. Unique identifier of entity. |
| `product_id` | uuid → Products | Required on create. Id of the product; required on create. |
| `paired_oppty_product_relation` | uri → OpptyProductRelations | Counterpart line item on the paired record (e.g. |
| `amount` | number | Total amount of the line item (price * quantity, with discounts applied). |
| `comment` | string | Free-form note describing this line item. |
| `currency_exchange_rates_list_id` | uuid → CurrencyExchangeRatesLists | Id of the currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. |
| `online_form_field_id` | uuid → Fields | Id 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. |
| `online_form_id` | uuid → OnlineForms | Id of the online form submission this line item came from, or empty when it was not created through a form. |
| `oppty_id` | uuid → Opportunities | Id of the opportunity. |
| `oppty_product_relation_type_id` | uuid → OpptyProductRelationTypes | Id of the line-item type. |
| `paired_oppty_product_relation_id` | uuid → OpptyProductRelations | Id of the paired line item. |
| `price` | number | Per-unit price of the line item. |
| `quantity` | number | Number of product units on this line item; a line item created without it gets 1. |
| `quote_id` | uuid → Quotes | Id of the quote this line item belongs to. |
| `section_id` | uuid | Identifier of the product section this line belongs to (see the product_sections JSON layout on the parent opportunity or quote). |
| `sort_order` | integer | Display order of the line item within its section. |
| `revision` | integer | Revision when entity was lastly changed. |
| `revenue_schedule` | uri → OpptyProductRelationRevenueSchedules | Per-line revenue schedule splitting the line amount across periods. |
| `is_delete_protected` | boolean | Read-only. True when the record is protected against deletion because it must always exist in the space. |
| `is_deleted` | boolean | Read-only. Specifies if the entity is considered deleted. |
| `modified` | date-time | Read-only. Last modification time. |
| `created` | date-time | Read-only. Creation time. |
| `currency_exchange_rates_list` | uri → CurrencyExchangeRatesLists | Read-only. Currency exchange rate list used to convert this line item, inherited from the parent opportunity or quote. |
| `online_form_field` | uri → Fields | Read-only. Online form field that produced this line item, or empty when not applicable. |
| `online_form` | uri → OnlineForms | Read-only. Online form this line item came from when the related opportunity was created through a form submission, or empty otherwise. |
| `oppty` | uri → Opportunities | Read-only. Opportunity this line item belongs to. |
| `oppty_product_relation_type` | uri → OpptyProductRelationTypes | Read-only. Line-item type that drives the form layout for this product line. |
| `product` | uri → Products | Read-only. Product on this line item. |
| `quote` | uri → Quotes | Read-only. Quote this line item belongs to. |
| `discount_value` | number | Read-only. Absolute discount of this line item against the product's price-list price, computed: a write that sends it is refused with HTTP 400, code 117. |
| `discount_percentage` | number | Read-only. Percentage discount of this line item against the product's price-list price, computed: a write that sends it is refused with HTTP 400, code 117. |
| `modified_by_user` | date-time | Read-only. Timestamp of the most recent modification made by an end user (excluding system changes). |

Custom fields appear in your space's live spec: `GET /api/v100/rest/spaces/{space_id}/openapi.json` with your credentials.

## Errors

Every error body has `success: false`, `http_status`, `code`, `name` and `message`. Branch on `code`: the status alone does not tell a missing permission from a bad parameter.

| HTTP | When |
| --- | --- |
| 400 | Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`. |
| 401 | Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED). |
| 404 | No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE). |
| 422 | Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written. |
| 429 | Too many requests (code 182). Wait for the seconds in Retry-After, then retry. |
| 500 | Unexpected server error (code 1000, ERROR_UNKNOWN). |

All error codes: https://developers.coevera.com/reference/errors.md; how to handle them: https://developers.coevera.com/concepts/errors.md

## Webhook events for opptyproductrelations

`OpptyProductRelation.Create`, `OpptyProductRelation.Delete`, `OpptyProductRelation.Update`. Payloads: https://developers.coevera.com/webhooks/events.md

Subscribe with [Create a webhook](https://developers.coevera.com/reference/rest/webhooks.md).