Update a deal product
patch
/crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealProduct/{DealProdId}
Request
Path Parameters
-
DealProdId(required): integer(int64)
The unique identifier of the deal registration product.
-
dealsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Deal Registrations resource and used to uniquely identify an instance of Deal Registrations. The client should not generate the hash key value. Instead, the client should query on the Deal Registrations collection resource in order to navigate to a specific instance of Deal Registrations to get the hash key.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount associated with the product line. The amount equals quantity times the registered price. -
ConvCurrencyCode: string
Maximum Length:
15
The currency code to which the currency on the deal registration must be converted to. For example, the corporate currency code. -
ConvExchangeRate: number
The exchange rate for converting the entered currency to the standard CRM corporate currency.
-
ConvRateType: string
Maximum Length:
30
The currency conversion rate type used to derive the exchange rate between the user entered currency and the CRM corporate currency code associated with the deal registration. -
CurrencyCode: string
Maximum Length:
15
The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
InventoryItemId: integer
(int64)
The unique identifier of the product inventory item associated with the deal registration.
-
InvOrgId: integer
(int64)
The unique identifier of the inventory organization.
-
ItemName: string
Title:
Item Description
Maximum Length:240
The name of the product associated with the deal registration. -
ProductGroupId: integer
(int64)
The unique identifier of the product group associated with the deal registration.
-
ProductGroupName: string
Title:
Name
Maximum Length:250
The name of the product group associated with the deal registration. -
ProductGroupNumber: string
Title:
Product Group Number
Maximum Length:50
Public Unique Identifier for Product Group in Deal Registration -
ProductType: string
Title:
Type
The product line type, such as product or product group. -
Quantity: number
Title:
Quantity
The quantity of the product or product group. -
RegisteredPrice: number
Title:
Registered Price
The registered price of the product. -
UOMCode: string
Title:
UOM
Maximum Length:3
The unit of measure of the product quantity.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : deals-DealProduct-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount associated with the product line. The amount equals quantity times the registered price. -
ConvCurrencyCode: string
Maximum Length:
15
The currency code to which the currency on the deal registration must be converted to. For example, the corporate currency code. -
ConvExchangeRate: number
The exchange rate for converting the entered currency to the standard CRM corporate currency.
-
ConvRateType: string
Maximum Length:
30
The currency conversion rate type used to derive the exchange rate between the user entered currency and the CRM corporate currency code associated with the deal registration. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the deal product record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the deal product record was created. -
CurrencyCode: string
Maximum Length:
15
The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
DealId: integer
(int64)
The unique identifier of the parent deal registration.
-
DealNumber: string
Title:
Registration Number
Maximum Length:30
The alternate unique identifier of the deal registration. -
DealProdId: integer
(int64)
The unique identifier of the deal registration product.
-
DealProdNumber: string
Maximum Length:
30
The alternate unique identifier of the deal registration product. -
InventoryItemId: integer
(int64)
The unique identifier of the product inventory item associated with the deal registration.
-
InvOrgId: integer
(int64)
The unique identifier of the inventory organization.
-
ItemDescription: string
Title:
Long Description
Read Only:true
Maximum Length:4000
The description of the product associated with the deal registration. -
ItemName: string
Title:
Item Description
Maximum Length:240
The name of the product associated with the deal registration. -
ItemNumber: string
Title:
Item Number
Read Only:true
Maximum Length:300
Public Unique Identifier for Item in Deal Registration -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the deal product record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the deal product record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the deal product record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProductGroupDescription: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the product group associated with the deal registration. -
ProductGroupId: integer
(int64)
The unique identifier of the product group associated with the deal registration.
-
ProductGroupName: string
Title:
Name
Maximum Length:250
The name of the product group associated with the deal registration. -
ProductGroupNumber: string
Title:
Product Group Number
Maximum Length:50
Public Unique Identifier for Product Group in Deal Registration -
ProductType: string
Title:
Type
The product line type, such as product or product group. -
Quantity: number
Title:
Quantity
The quantity of the product or product group. -
RegisteredPrice: number
Title:
Registered Price
The registered price of the product. -
UOMCode: string
Title:
UOM
Maximum Length:3
The unit of measure of the product quantity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- ProductGroupExtnLovVA
-
Parameters:
- finder:
ProductGroupList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMKL
Name for Product Group detail base public view object. - finder:
- ProductTypeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MOO_PROD_TYPE%2CBindLookupCode%3D{ProductType}
The lookups resource is used to view standard lookup codes. - finder:
- SalesCatalogExtnProductsLovVA
-
Operation: /crmRestApi/resources/11.13.18.05/productsParameters:
- finder:
ProductList%3BBind_UsageCode%3DBASE%2CBind_UsageModeCode%3DMKL
The product resource is used to view, create, or modify a product. A product is an item that an organization or company intends to sell. - finder:
Examples
The following example shows how to update a deal product by submitting a patch request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/deals/300100071395747/child/DealProduct/300100071521746
Example of Request Body
The following shows an example of the request body in JSON format.
{ "Quantity":100 }
Example of Response Body
The following shows an example of the response body in JSON format.
{ Amount: 10000 ConvCurrencyCode: "USD" ConvExchangeRate: 1 ConvRateType: "Corporate" CurrencyCode: "USD" DealId: 300100071395747 DealProdId: 300100071521746 ProductType: "Group" ProductGroupId: 100000011628005 Quantity: 100 RegisteredPrice: 100 ProductGroupName: "Electronics" ProductGroupDescription: "Electronics contains computers, printers and TVs " ... }