Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Product Line Items

OpptyProductRelations.update

Modifies OpptyProductRelation or OpptyProductRelations with given id(s)

patch/entities/OpptyProductRelations/{id}

Path parameters

idstring uuid required

ID of OpptyProductRelation to update

Query parameters

validation-levelinteger

Specify validation level of OpptyProductRelation on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

amountnumber double

Total amount of the line item (price * quantity, with discounts applied).

commentstring

Free-form note describing this line item.

currency_exchange_rates_list_idstring uuid

Id of the currency exchange rate list.

online_form_field_idstring uuid

Id of the online form field.

online_form_idstring uuid

Id of the online form.

oppty_idstring uuid

Id of the opportunity.

oppty_product_relation_type_idstring uuid

Id of the line-item type.

paired_oppty_product_relation_idstring uuid

Id of the paired line item.

pricenumber double

Per-unit price of the line item. Defaults to the product price from the price list when not supplied explicitly.

quantitynumber double

Number of product units on this line item.

quote_idstring uuid

Id of the quote.

section_idstring uuid

Identifier of the product section this line belongs to (see the product_sections JSON layout on the parent opportunity or quote).

sort_orderinteger

Display order of the line item within its section. Maintained automatically when lines are added or moved.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "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",
  "quote_id": "01234567-abcd-dcba-ffff-000000000000",
  "section_id": "01234567-abcd-dcba-ffff-000000000000",
  "sort_order": 1,
  "revision": 1
}

Response

Modification confirmation. Returns resulting OpptyProductRelation

successboolean

True when response 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"
  }
}