1. REST API for Oracle Loyalty Cloud
  2. Tasks
  3. Loyalty Promotions

Get all promotions

get

/crmRestApi/resources/11.13.18.05/loyPromotions

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the promotion with specified promotion identifier.
      Finder Variables:
      • LoyPromoId; integer; The promotion identifier.
    • PromoSearch: Finds the promotion with specified promotion name.
      Finder Variables:
      • Name; string; The loyalty promotion name.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActiveFlag; boolean; The boolean attribute that identifies whether the promotion is currently active or not. The default value is N. There is no dependency or limitation associated with this attribute.
    • ApplyToTiersFlag; boolean; The boolean attribute that indicates that the promotion is a tier promotion. Tier promotions are created when the program is set up with tiers. The default value is N. There is no dependency or limitation associated with this attribute.
    • BasePromoFlag; boolean; The boolean attribute that indicates that the promotion is a base promotion. Base promotions can calculate points based on transaction attributes, member attributes, promotion attributes, and so on. The default value is N. There is no dependency or limitation associated with this attribute.
    • CreatedBy; string; The loyalty user that created the promotion. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion. There is no default value, dependency, or limitation associated with this attribute.
    • CreationDate; string; The date when the promotion is created. Oracle Loyalty Cloud generates this attribute value during the creation of the new promotion. There is no default value, dependency, or limitation associated with this attribute.
    • Description; string; The additional details that pertain to the promotion. There is no default value, dependency associated with this attribute.
    • EndDate; string; The date used to decide if the products purchased qualify for the promotion reward. If the products purchased date is beyond the end date, then this promotion does not get applied to transaction. There is no default value, dependency, or limitation associated with this attribute.
    • EnrollmentAttribute; string; The attribute provides user with Incentive choice options that are provided along with the enrollable promotion. There is no default value, dependency or limitation associated with this attribute.
    • LastUpdateDate; string; The date when the promotion is updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are changes to the promotion. There is no default value, dependency, or limitation associated with this attribute.
    • LastUpdateLogin; string; The last login of the user that last updated the promotion. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are changes to the promotion. There is no default value, dependency, or limitation associated with this attribute.
    • LastUpdatedBy; string; The user that last updated the promotion. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are changes to the promotion. There is no default value, dependency, or limitation associated with this attribute.
    • LoyProgId; integer; The primary key of the loyalty program. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
    • Name; string; The name of the promotion. There is no default value, dependency, or limitation associated with this attribute.
    • OptInFlag; boolean; The boolean attribute that requires members to enroll for the promotion to get the reward if the attribute is selected. If the attribute is not selected, then all members of the program receive the reward for the promotion without enrolling in it. The default value is N. There is no dependency or limitation associated with this attribute.
    • OptinEndDate; string; The end date when members can no longer enroll into the promotion, if the promotion requires enrollment. The optional end date must fall within the promotion???s start and end dates. There is no default value or limitation associated with this attribute.
    • OptinStartDate; string; The start date when members can enroll into the promotion, if the promotion requires enrollment. The optional start date must fall within the promotion???s start and end dates. There is no default value or limitation associated with this attribute.
    • OrderFlag; boolean; The boolean attribute that indicates whether the promotion is used to reward members who make multiple purchases in a single order. The default value is N. There is no dependency or limitation associated with this attribute.
    • PartnerNumber; string; The partner number to which the promotion belongs. There is no default value, dependency, or limitation associated with this attribute.
    • PartyName; string; The attribute indicates the name of the partner to which the promotion belongs. There is no default value, dependency, or limitation associated with this attribute.
    • ProgramActiveFlag; boolean; The boolean attribute indicates whether the program for which the promotion is created is active or not. The default value is N. There is no dependency or limitation associated with this attribute.
    • ProgramName; string; The program for which the promotion is created. There is no default value, dependency, or limitation associated with this attribute.
    • ProgramNumber; string; The program number for which the promotion is created. There is no default value, dependency, or limitation associated with this attribute.
    • PromotionNumber; string; The unique key for identifying a promotion record, apart from the primary key. This attribute is mandatory during an update. Oracle Loyalty Cloud generates this attribute value. There is no default value or limitation associated with this attribute.
    • StartDate; string; The date when the promotion is effective and applicable. The date is used to determine if the products that are purchased qualify for the promotion reward. If the products purchased date is between the promotion start date and the end date, then the transaction qualifies for the promotion reward. There is no default value, dependency, or limitation associated with this attribute.
    • SubTypeCode; string; The promotion subtype code attribute is based on the promotion type. The accepted values are ORA_ACC_MCR (manual credit), ORA_ACC_PROD (product), ORA_ACC_ENR_BNS (enrollment bonus), and so on. There is no default value, dependency, or limitation associated with this attribute.
    • TierId; integer; The primary key of the loyalty tier. This key indicates the tier where the promotion belongs. There can only be one tier promotion for each tier. There is no default value, dependency, or limitation associated with this attribute.
    • TypeCode; string; The attribute indicates type of the promotion. The accepted values are ORA_TXN_ACC, ORA_TXN_RED, or ORA_TIER. There is no default value, dependency, or limitation associated with this attribute.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : loyPromotions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : loyPromotions-item-response
Type: object
Show Source
  • Title: Active
    Maximum Length: 1
    Default Value: false
    The boolean attribute that identifies whether the promotion is currently active or not. The default value is N. There is no dependency or limitation associated with this attribute.
  • Title: Apply to Tiers
    Maximum Length: 1
    Default Value: false
    The boolean attribute that indicates that the promotion is a tier promotion. Tier promotions are created when the program is set up with tiers. The default value is N. There is no dependency or limitation associated with this attribute.
  • Title: Base Promotion
    Maximum Length: 1
    Default Value: false
    The boolean attribute that indicates that the promotion is a base promotion. Base promotions can calculate points based on transaction attributes, member attributes, promotion attributes, and so on. The default value is N. There is no dependency or limitation associated with this attribute.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The loyalty user that created the promotion. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Created Date
    Read Only: true
    The date when the promotion is created. Oracle Loyalty Cloud generates this attribute value during the creation of the new promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Description
    Maximum Length: 250
    The additional details that pertain to the promotion. There is no default value, dependency associated with this attribute.
  • Title: End Date
    The date used to decide if the products purchased qualify for the promotion reward. If the products purchased date is beyond the end date, then this promotion does not get applied to transaction. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Enrollment Attribute
    Maximum Length: 30
    Default Value: Incentive Choice
    The attribute provides user with Incentive choice options that are provided along with the enrollable promotion. There is no default value, dependency or limitation associated with this attribute.
  • Title: Last Update Date
    Read Only: true
    The date when the promotion is updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are changes to the promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user that last updated the promotion. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are changes to the promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 32
    The last login of the user that last updated the promotion. Oracle Loyalty Cloud generates this attribute value and updates it whenever there are changes to the promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Title: Program
    The primary key of the loyalty program. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Loyalty Promotion ID
    The primary key to identify the promotion. Oracle Loyalty Cloud generates this attribute value during the creation of a promotion record. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Name
    Maximum Length: 50
    The name of the promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Enrollment End Date
    The end date when members can no longer enroll into the promotion, if the promotion requires enrollment. The optional end date must fall within the promotion???s start and end dates. There is no default value or limitation associated with this attribute.
  • Title: Enrollment Required
    Maximum Length: 1
    Default Value: false
    The boolean attribute that requires members to enroll for the promotion to get the reward if the attribute is selected. If the attribute is not selected, then all members of the program receive the reward for the promotion without enrolling in it. The default value is N. There is no dependency or limitation associated with this attribute.
  • Title: Enrollment Start Date
    The start date when members can enroll into the promotion, if the promotion requires enrollment. The optional start date must fall within the promotion???s start and end dates. There is no default value or limitation associated with this attribute.
  • Title: Order Level Promotion
    Maximum Length: 1
    Default Value: false
    The boolean attribute that indicates whether the promotion is used to reward members who make multiple purchases in a single order. The default value is N. There is no dependency or limitation associated with this attribute.
  • Title: Partner
    The identifier of the company that hosts the promotion. This company???s point block is debited when members earn points as a result of this promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Partner Number
    Read Only: true
    Maximum Length: 30
    The partner number to which the promotion belongs. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Partner
    Read Only: true
    Maximum Length: 360
    The attribute indicates the name of the partner to which the promotion belongs. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Program Active
    Read Only: true
    Maximum Length: 1
    The boolean attribute indicates whether the program for which the promotion is created is active or not. The default value is N. There is no dependency or limitation associated with this attribute.
  • Title: Program Name
    Maximum Length: 50
    The program for which the promotion is created. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Program Number
    Maximum Length: 30
    The program number for which the promotion is created. There is no default value, dependency, or limitation associated with this attribute.
  • Promotion Attributes
    Title: Promotion Attributes
    The promotion attributes resource is used to retrieve the details of promotion attributes defined for the promotion.
  • Promotion Incentive Choices
    Title: Promotion Incentive Choices
    The promotion incentive choices resource is used to retrieve the details of incentive choices defined for the promotion.
  • Title: Promotion Number
    Maximum Length: 30
    The unique key for identifying a promotion record, apart from the primary key. This attribute is mandatory during an update. Oracle Loyalty Cloud generates this attribute value. There is no default value or limitation associated with this attribute.
  • Title: Start Date
    The date when the promotion is effective and applicable. The date is used to determine if the products that are purchased qualify for the promotion reward. If the products purchased date is between the promotion start date and the end date, then the transaction qualifies for the promotion reward. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Subtype
    Maximum Length: 30
    The promotion subtype code attribute is based on the promotion type. The accepted values are ORA_ACC_MCR (manual credit), ORA_ACC_PROD (product), ORA_ACC_ENR_BNS (enrollment bonus), and so on. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Sub Type Meaning
    Read Only: true
    Maximum Length: 80
    The promotion subtype code attribute is based on the promotion type. The accepted values are Manual Credit, Product, Enrollment Bonus, and so on. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Tier ID
    The primary key of the loyalty tier. This key indicates the tier where the promotion belongs. There can only be one tier promotion for each tier. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Type
    Maximum Length: 30
    The attribute indicates type of the promotion. The accepted values are ORA_TXN_ACC, ORA_TXN_RED, or ORA_TIER. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Type Meaning
    Read Only: true
    Maximum Length: 80
    The attribute indicates the type of the promotion. The accepted values are Accrual, Redemption, or Tier. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : Promotion Attributes
Type: array
Title: Promotion Attributes
The promotion attributes resource is used to retrieve the details of promotion attributes defined for the promotion.
Show Source
Nested Schema : Promotion Incentive Choices
Type: array
Title: Promotion Incentive Choices
The promotion incentive choices resource is used to retrieve the details of incentive choices defined for the promotion.
Show Source
Nested Schema : loyPromotions-PromotionAttributes-item-response
Type: object
Show Source
  • Title: Active
    Maximum Length: 1
    Default Value: false
    The boolean attribute that specifies whether the created promotion attribute is enabled for use or not. The default value is N. There is no dependency or limitation associated with this attribute.
  • Title: Cancel Action Meaning
    Read Only: true
    Maximum Length: 80
    The specification of the action that must be applied during a transaction cancellation. The accepted values are Leave As Is (If selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Cancel Action Code
    Maximum Length: 30
    The specification of the action that must be applied during a transaction cancellation. The accepted values are Leave As Is (If selected, the value of the attribute remains the same when a transaction is cancelled), Revert, and so on. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The details of the loyalty user that created the promotion attribute. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Creation Date
    Read Only: true
    The date when the promotion is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Data Type Meaning
    Read Only: true
    Maximum Length: 80
    The promotion attribute data type indicates whether the attribute is a string, or a number, and so on. During transaction cancellation, Oracle Loyalty Cloud determines whether certain cancel actions must be applied or not, based on the data type name. For example, the Cancel Change action is available only for the Number data type. The Revert action is only available for String and Number data types, and the Leave As Is action is available for all data types. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Default Value
    Maximum Length: 75
    The default value that is used when the attribute is created for a member for the first time. There is no dependency or limitation associated with this attribute.
  • Title: Name
    Maximum Length: 30
    The promotion attribute display name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Field
    Maximum Length: 75
    The promotion attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Update Date
    Read Only: true
    The date when the promotion attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes occur to the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user that last updated the promotion. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes occur to the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user that last updated the promotion. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes occur to the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • Title: Attribute Definition ID
    The primary key of loyalty attributes. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Object Code
    Maximum Length: 30
    The option to select values from entities like Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Pick Applet
    Maximum Length: 75
    The pick applet field whose values are entered using a dialog box. When you are defining criteria and actions, then the dialog box with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Pick Field
    Maximum Length: 75
    The pick field whose value the user sees in the UI after selecting from the pick applet. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Pick Field Name
    Maximum Length: 75
    The promotion attribute pick field name is the user readable string of the PickField attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Pick List
    Maximum Length: 75
    The promotion attribute pick list is enabled if the attribute is a field whose values are entered using a picklist. When you are defining criteria and actions, the picklist with the values for this field is displayed. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Promotion ID
    The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Promotion Number
    Read Only: true
    Maximum Length: 30
    The promotion number to which the promotion attribute belongs. There is no default value, dependency, or limitation associated with this attribute.
Nested Schema : loyPromotions-PromotionIncentiveChoices-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    The details of the loyalty user that created the promotion incentive choice. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion incentive choice. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    The date when the promotion incentive choice is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion incentive choice attribute. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Default
    Maximum Length: 1
    Default Value: false
    The boolean attribute that indicates whether the incentive choice is the default choice or not for an enrollable promotion. Only one incentive choice can be made as default. The user can select one of the incentives choices defined under the promotion or can choose to select no value. There is no dependency or limitation associated with this attribute.
  • Title: Description
    Maximum Length: 100
    The additional information pertaining to the incentive choice attributes. There is no dependency or limitation associated with this attribute.
  • Title: Incentive Choice
    Maximum Length: 50
    The attribute that indicates the option of the incentive choice selected by the user while enrolling into an enrollable promotion, There is no default value or limitation associated with this attribute.
  • Read Only: true
    The date when the promotion incentive choice attribute is last updated. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes occur to the promotion incentive choice attributes. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 64
    The user that last updated the promotion incentive choice. Oracle Loyalty Cloud generates this attribute value and updates it whenever changes occur to the promotion attributes. There is no default value, dependency, or limitation associated with this attribute.
  • Read Only: true
    Maximum Length: 32
    The login details of the user that last updated the promotion incentive choice. Oracle Loyalty Cloud generates this attribute value and updates it whenever any changes occur to the promotion incentive choice attributes. There is no default value, dependency, or limitation associated with this attribute.
  • Links
  • The primary key to identify the promotion incentive choice. Oracle Loyalty Cloud generates this attribute value during the creation of a promotion incentive choice record. There is no default value, dependency, or limitation associated with this attribute.
  • The primary key of loyalty promotions. Oracle Loyalty Cloud generates this attribute value. There is no default value, dependency, or limitation associated with this attribute.
  • Title: Promotion Number
    Read Only: true
    Maximum Length: 30
    The promotion number to which the promotion incentive choice belongs. There is no default value, dependency, or limitation associated with this attribute.
Back to Top

Examples

This example shows how to retrieve all loyalty promotions in the system.

Use GET with the following URI syntax to retrieve all loyalty promotions:

https://example.com:port/crmRestApi/resources/11.13.18.05/loyPromotions

Example of Response Header

cache-control -no-cache, no-store, must-revalidate
connection -Keep-Alive
content-encoding -gzip
content-language -en
content-length -3742
content-type -application/vnd.oracle.adf.resourcecollection+json
date -Wed, 22 Aug 2018 18:18:32 GMT
keep-alive -timeout=61, max=100
link - <https://example.com:port/crmRestApi/resources/11.13.18.05/loyPromotions>;rel="self";kind="collection";name="loyPromotions"
location -
rest-framework-version -1
server -Oracle-HTTP-Server
vary -User-Agent
x-content-type-options -nosniff
x-oracle-dms-ecid -005T0cfXUapEoIILIqL6if0001wh0001Hq

Example of Response Body

{
    "items": [
        {
            "LoyPromoId": 300100129323791,
            "CreatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
            "LastUpdatedBy": "LOYALTY_PROGRAM_ADMINISTRATOR",
            "LastUpdateLogin": "7387847AA0CB4F00E05334C4F00AFE6A",
            "CreationDate": "2018-08-16T06:12:00+00:00",
            "LastUpdateDate": "2018-08-16T06:15:54+00:00",
            "ActiveFlag": false,
            "AdministratorFlag": false,
            "AlwaysApplyFlag": false,
            "ApplyToTiersFlag": false,
            "AvlToProcflwFlag": false,
            "BasePromoFlag": false,
            "BUId": 0,
            "Description": "This is a test promotion.",
            "EffVchrPrdTpCode": null,
            "EffVchrPrdVal": null,
            "EndDate": "2020-07-31T00:00:00+00:00",
            "ExportFlag": false,
            "FinalExecDate": null,
            "LoyProgId": 300100129314197,
            "MktgOffrId": null,
            "Name": "test-responsive-UI-1234567",
            "NumberTimes": null,
            "OptinEndDate": "2018-08-17T06:12:00+00:00",
            "OptinStartDate": "2018-08-16T00:00:00+00:00",
            "OptInFlag": false,
            "OrderFlag": false,
            "PartnerId": 300100033195690,
            "PkgAcrlFlag": false,
            "PointLimitCode": null,
            "ProdInclusionCode": null,
            "PromotionNumber": "0",
            "PrPromoLogoId": null,
            "PartnerProcDate": null,
            "PartnerReworkStatCode": null,
            "PartnerUserId": null,
            "RuleModelCode": null,
            "SmDescriptionText": null,
            "SrcId": null,
            "SrmRequiredId": null,
            "StartDate": "2018-08-16T00:00:00+00:00",
            "SubTypeCode": "ORA_ACC_PROD",
            "TierId": null,
            "TypeCode": "ORA_TXN_ACC",
            "MemInclusionId": null,
            "TierInclusionId": null,
            "ProgramName": "Auto Miles",
            "ProgramActiveFlag": true,
            "PartyName": "Avengers Inc",
            "EnrollmentAttribute": "Incentive Choice",
            "links": [
                {
                    "rel": "self",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPromotions/300100129323791",
                    "name": "loyPromotions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPromotions/300100129323791",
                    "name": "loyPromotions",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPromotions/300100129323791/lov/ProgramPVO2",
                    "name": "ProgramPVO2",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPromotions/300100129323791/lov/LookupPVO",
                    "name": "LookupPVO",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPromotions/300100129323791/lov/ProgramPartnerPVO",
                    "name": "ProgramPartnerPVO",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPromotions/300100129323791/lov/PromotionTypePVO",
                    "name": "PromotionTypePVO",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPromotions/300100129323791/child/PromotionIncentiveChoices",
                    "name": "PromotionIncentiveChoices",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPromotions/300100129323791/child/PromotionAttributes",
                    "name": "PromotionAttributes",
                    "kind": "collection"
                }
            ]
        },
.
.
.
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://example.com:port/crmRestApi/resources/11.13.18.05/loyPromotions",
            "name": "loyPromotions",
            "kind": "collection"
        }
    ]
}
Back to Top