Promotion Groups
The Promotion Group object is a search criteria for selecting products to add to a Promotion. A promotion group enables you to apply or modify promotion tactics on a number of products at once.
|
Resource Plural Label |
Promotion Groups |
|
Resource Name |
__ORACO__PromotionGroupCollection_c |
Get All Promotion Groups
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Promotion_c/{Id}/child/__ORACO__ PromotionGroupCollection_c
Request Path Parameters
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. |
Request Query Parameters
Use the following finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
PrimaryKey |
The unique identifier of the Promotion Group. You can get the Promotion Id by examining the response payload of a Get All Promotion Groups request. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
The following table summarizes the supported response body content types:
|
Media Type |
application/json |
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Example
This example gets all promotion groups for the Promotion Id 30000000087511.12.1.04.
Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORACO__Promotion_c/30000000087511.12.1.04/child/__ORACO__ PromotionGroupCollection_c
Get a Promotion Group
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Promotion_c/{Id}child/__ORACO__ PromotionGroupCollection_c/{Id}
Request Path Parameters
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. |
|
Id |
integer |
The unique identifier of the Promotion Group. You can get the Promotion Group Id by examining the response payload of a Get All Promotion Groups request. |
Request Body
There are no elements in the request body for this task.
Response Body
The following table summarizes the supported response body content types:
|
Media Type |
application/json |
|
Media Type |
application/vnd.oracle.adf.resourceitem+json |
Example
This example gets a promotion group.
Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/__ORACO__Promotion_c/30000000087511.12.1.04/child/__ORACO__PromotionGroupCollection_c/30000000087511.12.1.07
Create a Promotion Group
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Promotion_c/{Id}/child/__ORACO__ PromotionGroupCollection_c
Request Path Parameters
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. |
Request Body
The following table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourceitem+json |
Response Body
The following table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a Promotion Group
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Promotion_c/{Id}child/__ORACO__ PromotionGroupCollection_c/{Id}
Request Path Parameters
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. |
|
Id |
integer |
The unique identifier of the Promotion Group. You can get the Promotion Group Id by examining the response payload of a Get All Promotion Groups request. |
Request Body
The following table summarizes the supported request body content type:
|
Media Type |
application/vnd.oracle.adf.resourceitem+json |
Response Body
The following table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourceitem+json |
Delete a Promotion Group
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Promotion_c/{Id}child/__ORACO__ PromotionGroupCollection_c/{Id}
Request Path Parameters
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions request. |
|
Id |
integer |
The unique identifier of the Promotion Group. You can get the Promotion Group Id by examining the response payload of a Get All Promotion Groups request. |
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.
Example
This example deletes an existing promotion group resource with the Id 30000000087511.12.1.07 from a promotion resource with Id 300000000875131.
Example Command: curl --user sales_cloud_user -X DELETE https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORACO__Promotion_c/300000000875131/child/__ORACO__PromotionGroupCollection_c/30000000087511.12.1.07
List of Values
This resource defines the following list of values (LOV):
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
ViewAccessor_CurrencyCode |
CurrencyCode |
Currency |
|
LOVVA_For___ORACO__DiscountMethod_c |
__ORACO__DiscountMethod_c |
Discount Method |
|
LOVVA_For___ORACO__FundingMethod_c |
__ORACO__FundingMethod_c |
Funding Method |
|
FK_LOVVA_For___ORACO__Item_c |
__ORACO__Item_Id1_c |
Product |
|
LOVVA_For___ORACO__Item_c |
__ORACO__Item_c |
Product |
Resource Attributes
This resource has the following attributes:
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
A system-generated read-only attribute used by the application framework. UI Label Record ID |
|
RowType |
string |
A system-generated read-only attribute used by the application framework. Properties The maximum length is 80. |
|
RecordName |
string |
A system-generated read-only attribute used by the application framework. Properties The maximum length is 80. UI Label Audit History Name |
|
CreatedBy |
string |
The user who created the promotion group record. Properties The maximum length is 32. UI Label Created By |
|
CreationDate |
string |
The date when the record was created. UI Label Creation Date |
|
LastUpdatedBy |
string |
The user who last updated the record. Properties The maximum length is 32. UI Label Last Updated By |
|
LastUpdateDate |
string |
The date when the record was last updated. UI Label Last Update Date |
|
LastUpdateLogin |
string |
The login of the user who last updated the record. Properties The maximum length is 32. |
|
CpdrfVerSor |
integer |
A system-generated read-only attribute used by the application framework. |
|
UserLastUpdateDate |
string |
A system-generated read-only attribute used by the application framework. Disconnected Mobile: The date and time when the record was last updated from mobile. 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 |
A system-generated read-only attribute used by the application framework. Properties The maximum length is 15. |
|
CpdrfVerPillar |
integer |
A system-generated read-only attribute used by the application framework. |
|
JobDefinitionPackage |
string |
A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The name of the package running the job that created or last updated the row. Properties The maximum length is 900. |
|
RequestId |
integer |
A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The request identifier of the job that created or last updated the row. |
|
JobDefinitionName |
string |
A system-generated read-only attribute used by the application framework. Enterprise Service Scheduler: The short name the job that created or last updated the row. Properties The maximum length is 100. |
|
CurrencyCode |
string |
The currency code associated with the promotion group. Properties The maximum length is 15. UI Label Currency |
|
CurcyConvRateType |
string |
The currency conversion rate type associated with the promotion group. Properties The maximum length is 15. |
|
CorpCurrencyCode |
string |
Default currency code. Properties The maximum length is 15. |
|
IsOwner |
string |
A system-generated read-only attribute used by the application framework. Properties
|
|
__ORACO__Baseline_c |
integer |
A system-generated read-only attribute used by the application framework. Properties The maximum length is 10. UI Label Baseline |
|
__ORACO__Condition_c |
string |
A system-generated read-only attribute used by the application framework. Properties The maximum length is 1000. UI Label Condition |
|
__ORACO__DiscountMethod_c |
string |
The discount method associated with the promotion group. 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 term. Precision: 20 Decimal Places: 4 Properties The maximum length is 100. UI Label Discount |
|
__ORACO__DiscountAmount_c |
number |
The discount in absolute term. Precision: 20 Decimal Places: 2 Properties The maximum length is 20. 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__IncrementalLift_c |
number |
A system-generated read-only attribute used by the application framework. Precision: 20 Decimal Places: 4 Properties The maximum length is 100. UI Label Incremental Percentage |
|
__ORACO__Margin_c |
number |
A system-generated read-only attribute used by the application framework. Precision: 20 Decimal Places: 4 Properties The maximum length is 100. UI Label Margin Percentage |
|
__ORACO__Name_c |
string |
The Promotion Group name. Display Width: 30 Properties The maximum length is 1000. UI Label Name |
|
__ORACO__ItemDescription_c |
string |
The product name. Display Width: 30 Properties The maximum length is 1000. UI Label Product |
|
__ORACO__ItemNumber_c |
string |
The item number (SKU). Display Width: 30 Properties The maximum length is 1000. UI Label SKU |
|
__ORACO__PromotionNameBI_c |
string |
The name of a Promotion to be used in reports and analytics. Properties The maximum length is 1000. UI Label Promotion |
|
__ORACO__Promotion_Id_c |
Integer |
A copy of the unique identifier of a promotion. |
|
__ORACO__Promotion_c |
object |
The Promotion object. |