Promotions
Subcategories: Promotion Groups, Promotion Products
A Promotion is a marketing activity, often in the form of a discount or offer available, on select products. The promotion resource is used to view, create, or modify a promotion. Use this resource to create, update, find, and delete promotions.
|
Resource Plural Label |
Promotions |
|
Resource Name |
__ORACO__Promotion_c |
Get All Promotions
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__ Promotion_c
Request Path Parameters
There are no required path parameters for this task.
Request Query Parameters
Use the following finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
PrimaryKey |
The unique identifier of the Promotion. You can get the Promotion Id by examining the response payload of a Get All Promotions 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 promotions.
Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORACO__Promotion_c
Get a Promotion
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Promotion_c/{Id}
Request Path Parameters
The following are the required path parameters for this task:
| 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
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 with the Id 300000000875131.
Example Command: curl --user sales_cloud_user https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/__ORACO__Promotion_c/300000000875131
Create a Promotion
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Promotion_c
Request Path Parameters
There are no required path parameters for this task.
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 |
Update a Promotion
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Promotion_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. |
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
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Promotion_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. |
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 promotions resource with the 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
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 |
|
FK_LOVVA_For___ORACO__Account_c |
__ORACO__Account_Id_c |
Account |
|
LOVVA_For___ORACO__Account_c |
__ORACO__Account_c |
Account |
|
FK_LOVVA_For___ORACO__PromotionProgram_c |
__ORACO__PromotionProgram_Id_c |
Promotion program |
|
LOVVA_For___ORACO__PromotionProgram_c |
__ORACO__PromotionProgram_c |
Promotion Program |
|
LOVVA_For___ORACO__Status_c |
__ORACO__Status_c |
Status |
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 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 ID of the job that created or last updated the row. |
|
JobDefinitionName |
string |
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. Properties The maximum length is 15. UI Label Currency |
|
CurcyConvRateType |
string |
The currency conversion rate type associated with the promotion. Properties The maximum length is 15. |
|
CorpCurrencyCode |
string |
The corporate currency code of the promotion. Properties The maximum length is 15. |
|
SourceType |
string |
A system-generated read-only attribute used by the application framework. |
|
AttachmentEntityName |
string |
A system-generated read-only attribute used by the application framework. The name of the object or table that is associated with attachments for this object. |
|
PKProxy |
string |
A system-generated read-only attribute used by the application framework. Properties The maximum length is 18. |
|
IsOwner |
string |
A system-generated read-only attribute used by the application framework. |
|
__ORACO__Account_Id_c |
integer |
A copy of the unique identifier of an account. UI Label Account |
|
__ORACO__Account_c |
string |
The name of an account. Properties The maximum length is 1500. UI Label Account |
|
__ORACO__AccountBI_c |
string |
The name of an account for use in reports and analytics. Properties The maximum length is 1000. UI Label Account |
|
__ORACO__Advertising_c |
number |
The advertising budget allocation. Precision: 20 Decimal Places: 2 UI Label Advertising |
|
__ORACO__Catalog_c |
number |
The catalog budget allocation. Precision: 20 Decimal Places: 2 UI Label Catalog |
|
__ORACO__Description_c |
string |
The description of the promotion. Display Width: 30 Properties The maximum length is 1000. UI Label Description |
|
__ORACO__EndDate_c |
string |
The date and time when the promotion ends. UI Label End Date |
|
__ORACO__Merchandising_c |
number |
The budget allocated for merchandising. Precision: 20 Decimal Places: 2 UI Label Merchandising |
|
__ORACO__PromotionProgram_Id_c |
integer |
A copy of the unique identifier of a Promotion Program. UI Label Promotion Program |
|
__ORACO__PromotionProgram_c |
string |
The name of the promotion program. Display Width: 40 Properties The maximum length is 1500. UI Label Promotion Program |
|
__ORACO__PromotionProgramBI_c |
string |
The name of a Promotion Program for use in reports and analytics. Properties The maximum length is 1000. UI Label Promotion Program |
|
__ORACO__ShipmentEndDate_c |
string |
The date and time when the shipment ends. UI Label Shipment End |
|
__ORACO__ShipmentStartDate_c |
string |
The date and time when the shipment starts. UI Label Shipment Start |
|
__ORACO__Space_c |
number |
The space budget allocation. Precision: 20 Decimal Places: 2 UI Label Space |
|
__ORACO__StartDate_c |
string |
The date and time when the promotion starts. UI Label Start Date |
|
__ORACO__Status_c |
string |
The status of the promotion. Properties The maximum length is 1500. UI Label Status |
|
__ORACO__Submit_Promo |
string |
UI button. Do not use. UI Label Submit |
|
__ORACO__Add_To_Cart |
string |
UI button. Do not use. UI Label Add to Cart |