Coupons
Subcategories: Attachments, Notes
The coupon resource is used to view, create, replace, delete, and update coupons.
|
Resource Plural Label |
Coupons |
|
Resource Name |
__ORACO__Coupon_c |
Get all coupons
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Coupon_c
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
|
Primary Key |
Finds a Coupon 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 coupon
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Coupon_c
Request Path Parameters
There are no request path parameters for this task.
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 coupon
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Coupon_c
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Coupon. |
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 coupon
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Coupon_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Coupon. |
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 coupon
Request: PUT
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Coupon_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Coupon. |
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 coupon
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__Coupon_c/{Id}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the Coupon. |
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 |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
Id |
integer |
The unique identifier of the coupon record. UI Label: Record ID |
|
RowType |
string |
This is the type field for categorization of records. Value will be __ORACO__PaymentLine DSD_c always. Properties: The maximum length is 80. |
|
RecordName |
string |
The name of the coupon record. Properties: The maximum length is 80. UI Label: Coupon Name |
|
CreatedBy |
string |
The user who created the record. Properties: The maximum length is 32. UI Label: Created By |
|
CreationDate |
datetime |
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 |
datetime |
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. |
|
UserLastUpdateDate |
datetime |
The date and time of the last update from mobile. |
|
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 Code |
|
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 This attribute is used by CRM Extensibility framework. Properties: The maximum length is 15. |
|
SourceType |
string |
The type of source object. A system-generated read-only attribute used by the application framework. Properties: The maximum length is 0. |
|
__ORACO__StartDate_c |
date |
The start date of the coupon. UI Label: Start Date |
|
__ORACO__EndDate_c |
date |
The expiration date of the coupon. UI Label: End Date |
|
__ORACO__CouponValue_c |
integer |
The monetary value of the coupon. UI Label: Coupon Value |
|
__ORACO__AuxiliaryAttribute01_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 01 |
|
__ORACO__AuxiliaryAttribute02_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 02 |
|
__ORACO__AuxiliaryAttribute03_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 03 |
|
__ORACO__AuxiliaryAttribute04_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 04 |
|
__ORACO__AuxiliaryAttribute05_c |
string |
Additional internal fields for development usage. Properties: The maximum length is 80. UI Label: Auxiliary Attribute 05 |
|
__ORACO__AuxiliaryAttribute06_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 06 |
|
__ORACO__AuxiliaryAttribute07_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 07 |
|
__ORACO__AuxiliaryAttribute08_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 08 |
|
__ORACO__AuxiliaryAttribute09_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 09 |
|
__ORACO__AuxiliaryAttribute10_c |
integer |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 10 |
|
__ORACO__AuxiliaryAttribute11_c |
date |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 11 |
|
__ORACO__AuxiliaryAttribute12_c |
date |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 12 |
|
__ORACO__AuxiliaryAttribute13_c |
datetime |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 13 |
|
__ORACO__AuxiliaryAttribute14_c |
datetime |
Additional internal fields for development usage. UI Label: Auxiliary Attribute 14 |