Update a sales lead product
patch
/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/MklProdAssoc1/{LeadProductId}
Request
Path Parameters
-
LeadProductId(required): integer(int64)
The unique identifier of the current sales lead product.
-
leadsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Sales Leads resource and used to uniquely identify an instance of Sales Leads. The client should not generate the hash key value. Instead, the client should query on the Sales Leads collection resource in order to navigate to a specific instance of Sales Leads 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 sales lead product. -
AverageTimeToClose: number
Title:
Average Time to Close
The average time to close for this sales lead product. -
ConflictId: integer
Title:
Conflict Identifier
Default Value:0
The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the lead product line amount. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Description: string
Title:
Item Description
Maximum Length:240
The product description where the product is associated with the lead. -
EstimatedUnitPrice: number
Title:
Estimated Unit Price
The estimated unit price for this lead product. -
InventoryItemId: integer
(int64)
Title:
Inventory Number
The unique inventory item identifier associated with the lead product. -
LeadProductId: integer
(int64)
Title:
Lead Product ID
The unique identifier of the current sales lead product. -
OrganizationId: integer
(int64)
Title:
Organization
The unique inventory organization identifier associated with this lead product. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates whether this product is a primary product for this lead. -
ProductGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group. -
ProductGroupName: string
Title:
Product Group Name
Maximum Length:250
The name of the product group associated with the sales lead product resource. -
ProductGroupReferenceNumber: string
Title:
Product Group Reference Number
Maximum Length:50
The alternate key for referenced product group. -
ProductType: string
Title:
Product Type
The type of the product, such as item or product group. -
Quantity: number
Title:
Quantity
The product quantity identified for this product on the lead. -
UOMCode: string
Title:
UOM
Maximum Length:3
The unit of measure associated with this sales lead product line.
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 : leads-MklProdAssoc1-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount associated with the sales lead product. -
AverageTimeToClose: number
Title:
Average Time to Close
The average time to close for this sales lead product. -
ConflictId: integer
Title:
Conflict Identifier
Default Value:0
The value guarantees the uniqueness of the row when duplicates are created in different databases such as mobile databases, or the server. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created this sales lead product. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when this sales lead product is created. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the lead product line amount. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. You can review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Description: string
Title:
Item Description
Maximum Length:240
The product description where the product is associated with the lead. -
EstimatedUnitPrice: number
Title:
Estimated Unit Price
The estimated unit price for this lead product. -
InventoryItemId: integer
(int64)
Title:
Inventory Number
The unique inventory item identifier associated with the lead product. -
ItemNumber: string
Title:
Inventory Item Number
Read Only:true
Maximum Length:300
The alternate key for referenced inventory item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time of the last update of the sales lead product. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the sales lead product. -
LastUpdateLogin: string
Title:
Last Updated Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the sales lead for this sales lead product. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The alternate unique identifier of the lead. -
LeadProductId: integer
(int64)
Title:
Lead Product ID
The unique identifier of the current sales lead product. -
LeadProductNumber: string
Title:
Lead Product Number
Maximum Length:30
The alternate key of the lead product. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongDescription: string
Title:
Long Description
Read Only:true
Maximum Length:4000
A detailed description of the sales lead product. -
OrganizationId: integer
(int64)
Title:
Organization
The unique inventory organization identifier associated with this lead product. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Indicates whether this product is a primary product for this lead. -
ProductGroupDescription: string
Title:
Product Group Description
Read Only:true
Maximum Length:1000
A brief description of the product group. -
ProductGroupId: integer
(int64)
Title:
Product Group ID
The unique identifier of the product group. -
ProductGroupName: string
Title:
Product Group Name
Maximum Length:250
The name of the product group associated with the sales lead product resource. -
ProductGroupReferenceNumber: string
Title:
Product Group Reference Number
Maximum Length:50
The alternate key for referenced product group. -
ProductType: string
Title:
Product Type
The type of the product, such as item or product group. -
Quantity: number
Title:
Quantity
The product quantity identified for this product on the lead. -
UOMCode: string
Title:
UOM
Maximum Length:3
The unit of measure associated with this sales lead product line.
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:
- ProductTypeLookupVOVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_LEAD_PRODUCT_TYPE
The lookups resource is used to view standard lookup codes. - finder:
- RatedCurrenciesVA
-
The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
- 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
cURL Command
The following example shows how to update a sales lead product by submitting a PATCH request on the REST resource using cURL.
curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/leads/{lead_id}/child/MklProdAssoc1/300100092582203
Example of Request Body
The following shows an example of the request body in JSON format.
{ "PrimaryFlag" : true }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "LeadProductId" : 300100092582211, "LeadId" : 300100092582093, "OrganizationId" : 204, "CurrencyCode" : "USD", "EstimatedUnitPrice" : null, "InventoryItemId" : 999997500683977, "PrimaryFlag" : true, "ProductGroupId" : null, "Quantity" : null, "UOMCode" : null, "Description" : " OPN - World Applications - Certified Partner", "CreatedBy" : "MHoope", "CreationDate" : "2016-11-07T04:53:47-08:00", "LastUpdatedBy" : "MHoope", "LastUpdateDate" : "2016-11-07T04:57:38-08:00", "AverageTimeToClose" : null, "ProductGroupName" : null, "ProductGroupDescription" : null, "LongDescription" : "License/Applications/ERP Applications/PeopleSoft ERP Applications/JD Edwards World ERP/OPN - World License/ OPN - World Applications - Certified Partner", "Amount" : null, "links" : [ { ............. }] }