Product Line Items

OpptyProductRelations.get

Returns the OpptyProductRelation record with the given id.

get/entities/OpptyProductRelations/{id}

Request

Path parameters

idstring uuid required

Id of the OpptyProductRelation record to retrieve.

Query parameters

expandstring

Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Response

The OpptyProductRelation record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "comment": "string",
    "currency_exchange_rates_list_id": "01234567-abcd-dcba-ffff-000000000000",
    "online_form_field_id": "01234567-abcd-dcba-ffff-000000000000",
    "online_form_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "oppty_product_relation_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "paired_oppty_product_relation_id": "01234567-abcd-dcba-ffff-000000000000",
    "product_id": "01234567-abcd-dcba-ffff-000000000000",
    "quote_id": "01234567-abcd-dcba-ffff-000000000000",
    "section_id": "01234567-abcd-dcba-ffff-000000000000",
    "sort_order": 1,
    "revision": 1,
    "discount_value": 4.32,
    "discount_percentage": 4.32,
    "modified_by_user": "2019-01-01T00:00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.