Promotion Product Collections
The promotion product resource includes all the products that are to be promoted under the program. A promotion product can be individually added or added through a promotion group.
|
Resource Plural Label |
Promotion Product Collections |
|
Resource Name |
__ORACO__ProgramProductCollection_c |
- Methods:
- List of Values
- Resource Attributes
Get All Promotion Program Product Collections
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PromotionProgram_c/{id}/child/__ORACO__ProgramProductCollection_c
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the promotion program. |
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
| Primary Key |
Finds a promotion group with the specified primary key. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create a Promotion Program Product Collection
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PromotionProgram_c/{id}/child/__ORACO__ProgramProductCollection_c
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the promotion program. |
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a Promotion Program Product Collection
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PromotionProgram_c/{id}/child/__ORACO__ProgramProductCollection_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the promotion program. |
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a Promotion Program Product Collection
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PromotionProgram_c/{id}/child/__ORACO__ProgramProductCollection_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the promotion program. |
| Id | integer | The unique identifier of the promotion product. |
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a Promotion Program Product Collection
Request: PUT
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PromotionProgram_c/{id}/child/__ORACO__ProgramProductCollection_c/{id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the promotion program. |
| Id | integer | The unique identifier of the promotion product. |
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete a Promotion Program Product Collection
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__PromotionProgram_c/{id}/child/__ORACO__ProgramProductCollection_c/{id}
Request Path Parameters
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the promotion program. |
| Id | integer | The unique identifier of the promotion product. |
Enter request path parameters table
Request Body
There are no elements in the request body for this task.
Response Body
There are no elements in the response body for this task.
List of Values
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
ViewAccessor_CurrencyCode |
CurrencyCode |
CurrencyCode |
|
LOVVA_For___ORACO__DiscountMethod_c |
LookupCode |
__ORACO__DiscountMethod_c |
|
LOVVA_For___ORACO__FundingMethod_c |
LookupCode |
__ORACO__FundingMethod_c |
|
FK_LOVVA_For___ORACO__Item_c |
InventoryItemId |
__ORACO__Item_Id1_c |
|
FK_LOVVA_For___ORACO__Item_c |
OrganizationId |
__ORACO__Item_Id2_c |
|
LOVVA_For___ORACO__Item_c |
Description |
__ORACO__Item_c |
|
LOVVA_For___ORACO__Item_c |
InventoryItemId |
__ORACO__Item_Id1_c |
|
LOVVA_For___ORACO__Item_c |
OrganizationId |
__ORACO__Item_Id2_c |
|
FK_LOVVA_For___ORACO__SalesProduct_c |
InventoryItemId |
__ORACO__SalesProduct_Id_c |
|
LOVVA_For___ORACO__SalesProduct_c |
Name |
__ORACO__SalesProduct_c |
|
LOVVA_For___ORACO__SalesProduct_c |
InventoryItemId |
__ORACO__SalesProduct_Id_c |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the promotion product. UI Label: Record ID |
|
RowType |
string |
The type field for the categorization of the records. Properties: The maximum length is 80. |
|
RecordName |
string |
The name of the promotion product. Properties: The maximum length is 80. UI Label: Name |
|
CreatedBy |
string |
The user who created the promotion product. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
The date when the promotion product was created. UI Label: Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the promotion product. Properties: The maximum length is 32. UI Label: Last Updated By |
|
LastUpdateDate |
datetime |
The date when the promotion product was last updated. UI Label: Last Update Date |
|
__ORACO__PromotionProgram_Id_c |
integer |
The unique identifier of the promotion program. |
|
LastUpdateLogin |
string |
The login of the user who last updated the promotion product. Properties: The maximum length is 32. |
|
CpdrfVerSor |
integer |
The Cross Pillar Data Replication Framework (CPDRF) system column for tracking record version in the System of Record (SOR) pillar when a record change is replicated to subscribing pillars by the replication flows. It is a system-generated read-only attribute used by the application framework. |
|
UserLastUpdateDate |
datetime |
The date and time of the last user update made from a personal device. This value is different from LAST_UPDATE_DATE if the record was originally updated in a different database (That is, a different mobile database or the server). |
|
CpdrfLastUpd |
string |
The Cross Pillar Data Replication Framework (CPDRF) system column for tracking the source pillar name when a record is changed by the replication flows. Properties: The maximum length is 15. |
|
CpdrfVerPillar |
integer |
The Cross Pillar Data Replication Framework (CPDRF) system column for tracking the record version when a record is changed by replication flows |
|
JobDefinitionPackage |
string |
The name of the package running the job that created or last updated the row. Properties: The maximum length is 900. |
|
RequestId |
integer |
The unique identifier of the job request that created or last updated the row. |
|
JobDefinitionName |
string |
The name of the job request that created or last updated the row. Properties: The maximum length is 100. |
|
CurrencyCode |
string |
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. Properties: The maximum length is 15. UI Label: Currency |
|
CurcyConvRateType |
string |
The currency conversion rate type. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. Properties: The maximum length is 15. |
|
CorpCurrencyCode |
string |
The corporate currency code associated with the assortment. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. Properties: The maximum length is 15. |
|
IsOwner |
string |
A system-generated read-only attribute used by the application framework. |
|
__ORACO__Condition_c |
string |
This attribute is reserved and not for external use. Properties: The maximum length is 1000. UI Label: Condition |
|
__ORACO__DiscountMethod_c |
string |
The discount method used for the promotion products. It can be either percentage or amount. Properties: The maximum length is 1500. UI Label: Discount Method |
|
__ORACO__Discount_c |
number |
The discount in percentage. UI Label: Discount |
|
__ORACO__DiscountAmount_c |
number |
The discount in amount. UI Label: Discount Amount |
|
__ORACO__FundingMethod_c |
string |
The method to fund the discount tactics. It can be either Offinvoice or Billback. Properties: The maximum length is 1500. UI Label: Funding Method |
|
__ORACO__Item_Id1_c |
integer |
The unique identifier of the product item. It is used when 'ORACO_USE_SALES_PRODUCT' profile option is set to 'N'. UI Label: Product |
|
__ORACO__Item_Id2_c |
integer |
The foreign key for the product item. It is not visible in the user interface. It is used when 'ORACO_USE_SALES_PRODUCT' profile option is set to 'N'. UI Label: __ORACO__Item_Id2_c |
|
__ORACO__Item_c |
string |
The name of the product item. It is used when 'ORACO_USE_SALES_PRODUCT' profile option is set to 'N'. Properties: The maximum length is 1500. UI Label: Product |
|
__ORACO__PromotionGroupName_c |
string |
The name of the promotion group to which the product belongs. Properties: The maximum length is 1000. UI Label: Promotion Group |
|
__ORACO__ItemNumber_c |
string |
The item number (SKU) of the product. UI Label: SKU |
|
__ORACO__UnitPrice_c |
string |
The unit price of an item. UI Label: Unit Price |
|
__ORACO__UOM_c |
string |
The Unit of Measurement of the product. UI Label: UOM |
|
__ORACO__DiscountedPrice_c |
string |
The calculated discounted price of the product. UI Label: Discounted Price |
|
__ORACO__PromotionGroup_c |
string |
The name of the promotion group to which the product belongs. UI Label: Promotion Group |
|
__ORACO__SalesProduct_Id_c |
integer |
The unique identifier of the product. It is used when 'ORACO_USE_SALES_PRODUCT' profile option is set to 'N'. UI Label: Product |
|
__ORACO__SalesProduct_c |
string |
The name of the product. It is used when 'ORACO_USE_SALES_PRODUCT' profile option is set to 'N'. Properties: The maximum length is 1500. UI Label: Product |
|
__ORACO__UOMValue_c |
string |
The value of the Unit of Measurement of the product. Properties: The maximum length is 80. UI Label: UOM |
|
__ORACO__PromotionGroupId_c |
integer |
The unique identifier of the promotion group to which the product belongs. UI Label: Promotion Group Id |