Jump to

• Request
• Response
• Examples

Get all promotions (Deprecated)

get

/crmRestApi/resources/11.13.18.05/loyaltyPromotions

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  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
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • ActiveFlg; string; 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.
  • AdministratorFlg; string; The boolean attribute that indicates that the promotion is an Admin promotion. Admin promotions apply to every transaction for every member of the program. The default value is N. There is no dependency or limitation associated with this attribute.
  • AlwaysApplyFlg; string; The boolean attribute that specifies that the promotion always gets applied, regardless of the choice that is made in the promotion calculation rule for the program to which the promotion belongs. The default value is N. There is no dependency or limitation associated with this attribute.
  • ApplyToTiersFlg; string; 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.
  • AvlToProcflwFlg; string; The boolean attribute that specifies if a promotion can be used in a process flow. There is no default value, dependency, or limitation associated with this attribute.
  • BUId; integer; The promotion business unit identifier. Oracle Loyalty Cloud generates this attribute value during the creation of a promotion. There is no default value, dependency, or limitation associated with this attribute.
  • BasePromoFlg; string; 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.
  • ConflictId; integer; The promotion attribute conflict identifier. Oracle Loyalty Cloud generates this attribute. There is no default value, 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.
  • DescriptionText; string; The additional details that pertain to the promotion. There is no default value, dependency associated with this attribute.
  • EffVchrPrdTpCode; string; The effective voucher period type. The accepted values are Days, Months and Years. There is no default value, dependency, or limitation associated with this attribute.
  • EffVchrPrdVal; string; The effective voucher period value in the number of days, or months, or years, after which, the voucher expires. For example, if you select the period as 6 and a period type as Months, then the voucher expires after six months. There is no default value, dependency, or limitation associated with this attribute.
  • EndDt; 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.
  • ExportFlg; string; The boolean attribute that indicates whether the promotion can be exported or not. Exported promotions can be imported into another system with less effort than non-exported promotions. The default value is N. There is no dependency or limitation associated with this attribute.
  • FinalExecDt; string; The date that provides the details of when to run the qualifying rule, if any. 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.
  • LoyPromoId; integer; 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.
  • MemInclusionId; string; The attribute indicates promotion is applicable for the member. There is no default value, dependency, or limitation associated with this attribute.
  • MktgOffrId; integer; The marketing offer that is associated with the promotion. 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.
  • NumberTimes; number; The number of times a member can qualify for a promotion. A value of 0 (zero) means the member can qualify an infinite number of times. There is no default value, dependency, or limitation associated with this attribute.
  • ObjectVersionNumber; integer; The object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
  • OptInFlg; string; The boolean attribute that requires members to enroll for the promotion to get the reward, if it 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.
  • OptinEndDt; 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.
  • OptinStartDt; 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.
  • OrderFlg; string; 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.
  • PartnerId; integer; 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.
  • PkgAcrlFlg; string; The boolean attribute that specifies that the points for the promotion are shared by multiple partners, if it is selected. The default value is N. There is no dependency or limitation associated with this attribute.
  • PointLimitCode; string; The limit of the points for the promotion that are taken from the company or the partner that owns the promotion. There is no default value, dependency, or limitation associated with this attribute.
  • PrPromoLogoId; integer; The attribute specifies the primary promotion logo details. There is no default value, dependency, or limitation associated with this attribute.
  • ProdInclusionCode; string; The product inclusion code attribute that is used to decide if a promotion applies to all products or only to the products that are specified. There is no default value, 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.
  • PromoNumber; string; The unique key for identifying a promotion record, apart from 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.
  • PtnrProcDt; string; The date and time details for when the partner reviews the promotion and approves or rejects it. There is no default value, dependency, or limitation associated with this attribute.
  • PtnrRvwStatCode; string; The partner review status of the promotion. There is no default value, dependency, or limitation associated with this attribute.
  • PtnrUserId; integer; The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.
  • RuleModelCode; string; The rule model attribute is used to specify if it is a hierarchical rule or individual rule. There is no default value, dependency, or limitation associated with this attribute.
  • SmDescriptionText; string; The promotion small description text attribute describes the promotion in short text. There is no default value, dependency, or limitation associated with this attribute.
  • SrcId; integer; The promotion marketing campaign identifier. Marketing campaigns are used to target members with an outbound communication. Marketing campaigns are based on contacts, and not on members. There is no default value, dependency, or limitation associated with this attribute.
  • SrmRequiredId; integer; The foreign key to the repeating server request, if time is specified. This attribute is used for processing a repetitive job as a background process. There is no default value, dependency, or limitation associated with this attribute.
  • StartDt; 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.
  • SubTypeName; string; The promotion subtype details. This attribute is based on the promotion type. The accepted values are Manual, Credit, Product, 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.
  • TierInclusionId; string; The attribute indicates that the promotion is applicable for the tiers included in the list, which can be seen under promotions There is no default value, dependency, or limitation associated with this attribute.
  • TypeName; string; 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.
• totalResults: boolean
  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

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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".
• REST-Framework-Version(required):
  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 : loyaltyPromotions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/loyaltyPromotions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"Loyalty"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object loyaltyPromotions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/loyaltyPromotions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : loyaltyPromotions-item-response

Type: object

Show Source

• ActiveFlg: string
  Title: Active

  Maximum Length: 1

  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.
• AdministratorFlg: string
  Maximum Length: 1

  The boolean attribute that indicates that the promotion is an Admin promotion. Admin promotions apply to every transaction for every member of the program. The default value is N. There is no dependency or limitation associated with this attribute.
• AlwaysApplyFlg: string
  Maximum Length: 1

  The boolean attribute that specifies that the promotion always gets applied, regardless of the choice that is made in the promotion calculation rule for the program to which the promotion belongs. The default value is N. There is no dependency or limitation associated with this attribute.
• ApplyToTiersFlg: string
  Maximum Length: 1

  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.
• AvlToProcflwFlg: string
  Maximum Length: 1

  The boolean attribute that specifies if a promotion can be used in a process flow. There is no default value, dependency, or limitation associated with this attribute.
• BasePromoFlg: string
  Title: Base Promotion

  Maximum Length: 1

  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.
• BUId: integer (int64)
  The promotion business unit identifier. Oracle Loyalty Cloud generates this attribute value during the creation of a promotion. There is no default value, dependency, or limitation associated with this attribute.
• ConflictId: integer (int64)
  The promotion attribute conflict identifier. Oracle Loyalty Cloud generates this attribute. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  Title: Created By

  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.
• CreationDate: string (date-time)
  Title: Created Date

  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.
• DescriptionText: string
  Title: Description

  Maximum Length: 250

  The additional details that pertain to the promotion. There is no default value, dependency associated with this attribute.
• EffVchrPrdTpCode: string
  Maximum Length: 30

  The effective voucher period type. The accepted values are Days, Months and Years. There is no default value, dependency, or limitation associated with this attribute.
• EffVchrPrdVal: string
  Maximum Length: 15

  The effective voucher period value in the number of days, or months, or years, after which, the voucher expires. For example, if you select the period as 6 and a period type as Months, then the voucher expires after six months. There is no default value, dependency, or limitation associated with this attribute.
• EndDt: string (date-time)
  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.
• ExportFlg: string
  Title: Export

  Maximum Length: 1

  The boolean attribute that indicates whether the promotion can be exported or not. Exported promotions can be imported into another system with less effort than non-exported promotions. The default value is N. There is no dependency or limitation associated with this attribute.
• FinalExecDt: string (date-time)
  The date that provides the details of when to run the qualifying rule, if any. There is no default value, dependency, or limitation associated with this attribute.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  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.
• LastUpdatedBy: string
  Title: Last Updated By

  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.
• LastUpdateLogin: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyProgId: integer (int64)
  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.
• LoyPromoId: integer (int64)
  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.
• MemInclusionId: string
  Maximum Length: 30

  The attribute indicates promotion is applicable for the member. There is no default value, dependency, or limitation associated with this attribute.
• MktgOffrId: integer (int64)
  The marketing offer that is associated with the promotion. There is no default value, dependency, or limitation associated with this attribute.
• Name: string
  Title: Name

  Maximum Length: 50

  The name of the promotion. There is no default value, dependency, or limitation associated with this attribute.
• NumberTimes: number
  The number of times a member can qualify for a promotion. A value of 0 (zero) means the member can qualify an infinite number of times. There is no default value, dependency, or limitation associated with this attribute.
• ObjectVersionNumber: integer (int32)
  The object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
• OptinEndDt: string (date-time)
  Title: Promotion 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.
• OptInFlg: string
  Maximum Length: 1

  The boolean attribute that requires members to enroll for the promotion to get the reward, if it 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.
• OptinStartDt: string (date-time)
  Title: Promotion 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.
• OrderFlg: string
  Maximum Length: 1

  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.
• PartnerId: integer (int64)
  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.
• PkgAcrlFlg: string
  Maximum Length: 1

  The boolean attribute that specifies that the points for the promotion are shared by multiple partners, if it is selected. The default value is N. There is no dependency or limitation associated with this attribute.
• PointLimitCode: string
  Maximum Length: 30

  The limit of the points for the promotion that are taken from the company or the partner that owns the promotion. There is no default value, dependency, or limitation associated with this attribute.
• ProdInclusionCode: string
  Maximum Length: 30

  The product inclusion code attribute that is used to decide if a promotion applies to all products or only to the products that are specified. There is no default value, dependency, or limitation associated with this attribute.
• ProgramName: string
  Title: Program

  Read Only: true

  Maximum Length: 50

  The program for which the promotion is created. There is no default value, dependency, or limitation associated with this attribute.
• PromoNumber: string
  Title: Promotion Number

  Maximum Length: 30

  The unique key for identifying a promotion record, apart from 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.
• PromotionAttributes: array (Deprecated) Promotion Attributes
  Title: (Deprecated) Promotion Attributes

  The loyalty promotions resource is used to retrieve the details of promotion attributes defined for the promotion.
• PrPromoLogoId: integer (int64)
  The attribute specifies the primary promotion logo details. There is no default value, dependency, or limitation associated with this attribute.
• PtnrProcDt: string (date-time)
  The date and time details for when the partner reviews the promotion and approves or rejects it. There is no default value, dependency, or limitation associated with this attribute.
• PtnrRvwStatCode: string
  Maximum Length: 30

  The partner review status of the promotion. There is no default value, dependency, or limitation associated with this attribute.
• PtnrUserId: integer (int64)
  The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.
• RuleModelCode: string
  Maximum Length: 30

  The rule model attribute is used to specify if it is a hierarchical rule or individual rule. There is no default value, dependency, or limitation associated with this attribute.
• SmDescriptionText: string
  Maximum Length: 250

  The promotion small description text attribute describes the promotion in short text. There is no default value, dependency, or limitation associated with this attribute.
• SrcId: integer (int64)
  The promotion marketing campaign identifier. Marketing campaigns are used to target members with an outbound communication. Marketing campaigns are based on contacts, and not on members. There is no default value, dependency, or limitation associated with this attribute.
• SrmRequiredId: integer (int64)
  The foreign key to the repeating server request, if time is specified. This attribute is used for processing a repetitive job as a background process. There is no default value, dependency, or limitation associated with this attribute.
• StartDt: string (date-time)
  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.
• SubTypeName: string
  The promotion subtype details. This attribute is based on the promotion type. The accepted values are Manual, Credit, Product, and so on. There is no default value, dependency, or limitation associated with this attribute.
• TierId: integer (int64)
  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.
• TierInclusionId: string
  Maximum Length: 32

  The attribute indicates that the promotion is applicable for the tiers included in the list, which can be seen under promotions There is no default value, dependency, or limitation associated with this attribute.
• TypeName: string
  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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Created Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "TypeName":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PtnrUserId":{
            "type":"integer",
            "description":"The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierInclusionId":{
            "maxLength":32,
            "type":"string",
            "description":"The attribute indicates that the promotion is applicable for the tiers included in the list, which can be seen under promotions There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PrPromoLogoId":{
            "type":"integer",
            "description":"The attribute specifies the primary promotion logo details. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The promotion attribute conflict identifier. Oracle Loyalty Cloud generates this attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "BasePromoFlg":{
            "title":"Base Promotion",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ProdInclusionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The product inclusion code attribute that is used to decide if a promotion applies to all products or only to the products that are specified. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AlwaysApplyFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that specifies that the promotion always gets applied, regardless of the choice that is made in the promotion calculation rule for the program to which the promotion belongs. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "MktgOffrId":{
            "type":"integer",
            "description":"The marketing offer that is associated with the promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NumberTimes":{
            "type":"number",
            "description":"The number of times a member can qualify for a promotion. A value of 0 (zero) means the member can qualify an infinite number of times. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PromotionAttributes":{
            "title":"(Deprecated) Promotion Attributes",
            "type":"array",
            "description":"The loyalty promotions resource is used to retrieve the details of promotion attributes defined for the promotion.",
            "items":{
                "$ref":"#/components/schemas/loyaltyPromotions-PromotionAttributes-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PkgAcrlFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that specifies that the points for the promotion are shared by multiple partners, if it is selected. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "AdministratorFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that indicates that the promotion is an Admin promotion. Admin promotions apply to every transaction for every member of the program. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "LoyProgId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program",
            "maxLength":50,
            "type":"string",
            "description":"The program for which the promotion is created. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PtnrProcDt":{
            "type":"string",
            "description":"The date and time details for when the partner reviews the promotion and approves or rejects it. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SrmRequiredId":{
            "type":"integer",
            "description":"The foreign key to the repeating server request, if time is specified. This attribute is used for processing a repetitive job as a background process. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrcId":{
            "type":"integer",
            "description":"The promotion marketing campaign identifier. Marketing campaigns are used to target members with an outbound communication. Marketing campaigns are based on contacts, and not on members. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "OrderFlg":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "AvlToProcflwFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that specifies if a promotion can be used in a process flow. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "LoyPromoId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptInFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that requires members to enroll for the promotion to get the reward, if it 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.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleModelCode":{
            "maxLength":30,
            "type":"string",
            "description":"The rule model attribute is used to specify if it is a hierarchical rule or individual rule. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "EffVchrPrdVal":{
            "maxLength":15,
            "type":"string",
            "description":"The effective voucher period value in the number of days, or months, or years, after which, the voucher expires. \nFor example, if you select the period as 6 and a period type as Months, then the voucher expires after six months. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "BUId":{
            "type":"integer",
            "description":"The promotion business unit identifier. Oracle Loyalty Cloud generates this attribute value during the creation of a promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PromoNumber":{
            "title":"Promotion Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique key for identifying a promotion record, apart from 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.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDt":{
            "title":"Start Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PointLimitCode":{
            "maxLength":30,
            "type":"string",
            "description":"The limit of the points for the promotion that are taken from the company or the partner that owns the promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDt":{
            "title":"End Date",
            "type":"string",
            "description":"The date used to decide if the products purchased qualify for the promotion reward. If the products\npurchased 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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SubTypeName":{
            "type":"string",
            "description":"The promotion subtype details. This attribute is based on the promotion type. The accepted values are Manual, Credit, Product, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "MemInclusionId":{
            "maxLength":30,
            "type":"string",
            "description":"The attribute indicates promotion is applicable for the member. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplyToTiersFlg":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "OptinStartDt":{
            "title":"Promotion Enrollment Start Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EffVchrPrdTpCode":{
            "maxLength":30,
            "type":"string",
            "description":"The effective voucher period type. The accepted values are Days, Months and Years. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SmDescriptionText":{
            "maxLength":250,
            "type":"string",
            "description":"The promotion small description text attribute describes the promotion in short text. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PtnrRvwStatCode":{
            "maxLength":30,
            "type":"string",
            "description":"The partner review status of the promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportFlg":{
            "title":"Export",
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that indicates whether the promotion can be exported or not. Exported promotions can be imported into another system with less effort than non-exported promotions. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "TierId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptinEndDt":{
            "title":"Promotion Enrollment End Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlg":{
            "title":"Active",
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":250,
            "type":"string",
            "description":"The additional details that pertain to the promotion. There is no default value, dependency associated with this attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "FinalExecDt":{
            "type":"string",
            "description":"The date that provides the details of when to run the qualifying rule, if any. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : (Deprecated) Promotion Attributes

Type: array

Title: (Deprecated) Promotion Attributes

The loyalty promotions resource is used to retrieve the details of promotion attributes defined for the promotion.

Show Source

• Array of: object loyaltyPromotions-PromotionAttributes-item-response

{
    "title":"(Deprecated) Promotion Attributes",
    "type":"array",
    "description":"The loyalty promotions resource is used to retrieve the details of promotion attributes defined for the promotion.",
    "items":{
        "$ref":"#/components/schemas/loyaltyPromotions-PromotionAttributes-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : loyaltyPromotions-PromotionAttributes-item-response

Type: object

Show Source

• AccntActCode: string
  Read Only: true

  Maximum Length: 30

  The promotion attribute account activity code. If this option is specified, points expire if there is no activity of the type for the point type, within the period specified. There is no default value, dependency, or limitation associated with this attribute.
• ActiveFlg: string
  Read Only: true

  Maximum Length: 1

  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.
• AttrDefnId: integer (int64)
  Read Only: true

  The primary key value of the loyalty attribute definitions corresponding to attribute types such as pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute.
• AttrTypeCode: string
  Read Only: true

  Maximum Length: 30

  The promotion attribute type code. This attribute reflects the type of the attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.
• BusSvcName: string
  Read Only: true

  Maximum Length: 75

  The external business service that can be called in a promotion to evaluate the business criteria. There is no default value, dependency, or limitation associated with this attribute.
• CancelActionName: string
  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.
• ConflictId: integer (int64)
  Read Only: true

  The promotion attribute conflict identifier that Oracle Loyalty Cloud generates during the creation of a new promotion attribute. There is no default value, dependency, or limitation associated with this attribute.
• CostperPoint: number
  Read Only: true

  The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.
• CreatedBy: string
  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.
• CreationDate: string (date-time)
  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.
• CurcyCode: integer (int64)
  Read Only: true

  The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value or dependency associated with this attribute.
• CurcyExchDt: string (date)
  Read Only: true

  The date when the promotion attribute currency exchange takes place. This attribute displays the date of the currency exchange during promotion attributes creation. There is no default value, dependency, or limitation associated with this attribute.
• DataTypeName: string
  The promotion attribute data type name 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.
• DefaultVal: string
  Read Only: true

  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.
• DescriptionText: string
  Read Only: true

  Maximum Length: 1000

  The additional information pertaining to the attributes being used in the promotion criteria. There is no dependency or limitation associated with this attribute.
• DisplayFlg: string
  Read Only: true

  Maximum Length: 1

  The boolean attribute that indicates whether the promotion attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.
• DisplayName: string
  Read Only: true

  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.
• DynamicFlg: string
  Read Only: true

  Maximum Length: 1

  The boolean attribute that indicates whether the promotion attribute value is calculated dynamically based on another attribute, which is used by the promotion criteria. The criteria can compare an attribute to a value or compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.
• ExpiryAlignCode: string
  Read Only: true

  Maximum Length: 30

  The details pertaining to the calculation of the expiry of points. There is no default value, dependency, or limitation associated with this attribute.
• ExpiryBasisCode: string
  Read Only: true

  Maximum Length: 30

  The basis for point or voucher expiry. The accepted values are Period (expires after a period of time) or Date (expires on a specific date). There is no default value, dependency, or limitation associated with this attribute.
• ExpiryDayCode: string
  Read Only: true

  Maximum Length: 30

  The day of the month when the points expire if the expiry basis is set to Date. The attribute has a dependency on the Expiry Basis Code attribute. There is no default value or limitation associated with this attribute.
• ExpiryMonthCode: string
  Read Only: true

  Maximum Length: 30

  The month when the points expire if the expiry basis is Month. The attribute has a dependency on the Expiry Basis Code attribute. There is no default value or limitation associated with this attribute.
• ExpPdUOMCode: string
  Read Only: true

  Maximum Length: 30

  The promotion attribute expiry period unit of measure (UOM) attribute is used to specify when points expire. For example, if the points expire after they are earned, UOM is Year. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.
• ExpPeriodLen: number
  Read Only: true

  The promotion attribute expiry period length is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange them for rewards. There is no default value, dependency, or limitation associated with this attribute.
• InternalName: string
  Read Only: true

  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.
• LastUpdateDate: string (date-time)
  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.
• LastUpdatedBy: string
  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.
• LastUpdateLogin: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoyAttrdefnBId: integer (int64)
  Read Only: true

  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.
• MergeActionCode: string
  Read Only: true

  Maximum Length: 30

  The promotion attribute merge action specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.
• MethodName: string
  Read Only: true

  Maximum Length: 75

  The method that is used in calculations of the promotion attribute value that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method returns the month name. There is no default value, dependency, or limitation associated with this attribute.
• MinimumReactivatnQuantity: number
  Read Only: true

  The minimum points required to reactive the expired points, so they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.
• MonthsLen: number
  Read Only: true

  The numeric value that corresponds to the number of months during which points will expire. There is no default value, dependency, or limitation associated with this attribute.
• ObjectCode: string
  Read Only: true

  Maximum Length: 30

  The option to select values from the entities like Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The promotion attribute object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.
• PickApplet: string
  Read Only: true

  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.
• PickField: string
  Read Only: true

  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.
• PickFieldName: string
  Read Only: true

  Maximum Length: 75

  The promotion attribute pick field name is the user readable string of the attribute PickField. There is no default value, dependency, or limitation associated with this attribute.
• PickList: string
  Read Only: true

  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.
• PrgFormulaId: integer (int64)
  Read Only: true

  The program formula identifier that is available for use by a promotion only if it is associated with the same program as the program for the promotion. The formula can be used in criteria for comparisons and in actions for assigning values or updating attributes with the formula value. There is no default value, dependency, or limitation associated with this attribute.
• PromotionId: integer (int64)
  Read Only: true

  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.
• QualPointFlg: string
  Read Only: true

  Maximum Length: 1

  The boolean attribute that indicates that the points accrued when the promotion are applied towards earning tier status, but that cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.
• ReactivateFlg: string
  Read Only: true

  Maximum Length: 1

  The reactivate flag attribute is used to reactivate members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.
• ReadonlyFlg: string
  Read Only: true

  Maximum Length: 1

  The boolean attribute specifies whether the promotion attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.
• RetEffFlg: string
  Read Only: true

  Maximum Length: 1

  The date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.
• RptExpPdUOMCode: string
  Read Only: true

  Maximum Length: 30

  The unit of measure (UOM) for the time period until the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year, then the unit of measure (UOM) is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• RptExpPeriodLen: number
  Read Only: true

  The time period until the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.
• TierClassId: integer (int64)
  Read Only: true

  The primary attribute of the loyalty tier class that indicates the class where a specific tier falls. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactor: number
  Read Only: true

  The promotion attribute weight factor is used to decide which promotion must be applied to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.
• WeightFactorNq: number
  Read Only: true

  The promotion attribute weight factor non-qualifying attribute is used to decide whether to generate qualifying or non-qualifying points of each type, when the weight factor attribute is specified. This attribute has a dependency on the Weight Factor attribute. There is no default value or limitation associated with this attribute.

{
    "type":"object",
    "properties":{
        "WeightFactor":{
            "type":"number",
            "description":"The promotion attribute weight factor is used to decide which promotion must be applied to the transaction, if multiple promotions qualify. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MonthsLen":{
            "type":"number",
            "description":"The numeric value that corresponds to the number of months during which points will expire. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromotionId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefaultVal":{
            "maxLength":75,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttrTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The promotion attribute type code. This attribute reflects the type of the attribute, for example, Field, Point Total, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttrDefnId":{
            "type":"integer",
            "description":"The primary key value of the loyalty attribute definitions corresponding to attribute types such as pointType, Member, Transaction, and so on. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReactivateFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The reactivate flag attribute is used to reactivate members points after they have expired. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that indicates whether the promotion attribute value is calculated dynamically based on another attribute, which is used by the promotion criteria. The criteria can compare an attribute to a value or compare an attribute to another attribute. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InternalName":{
            "maxLength":75,
            "type":"string",
            "description":"The promotion attribute internal name. The accepted values are Date1 or Number1. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The option to select values from the entities like Transaction, Member, Promotion and so on, when defining a promotion. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The promotion attribute conflict identifier that Oracle Loyalty Cloud generates during the creation of a new promotion attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplayFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that indicates whether the promotion attribute should be displayed or not, so that it can be used in the promotion criteria. The default value is Y. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelActionName":{
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MethodName":{
            "maxLength":75,
            "type":"string",
            "description":"The method that is used in calculations of the promotion attribute value that can be used in promotion criteria. For example, the ORA_CAL_METHOD_MONTH_NAME method returns the month name. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpPdUOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"The promotion attribute expiry period unit of measure (UOM) attribute is used to specify when points expire. For example, if the points expire after they are earned, UOM is Year. After the points expire, the member can no longer exchange the points for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PickFieldName":{
            "maxLength":75,
            "type":"string",
            "description":"The promotion attribute pick field name is the user readable string of the attribute PickField. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyCode":{
            "type":"integer",
            "description":"The currency used in the transaction. The accepted values are INR, USD, and GBP. There is no default value or dependency associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpiryMonthCode":{
            "maxLength":30,
            "type":"string",
            "description":"The month when the points expire if the expiry basis is Month. The attribute has a dependency on the Expiry Basis Code attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WeightFactorNq":{
            "type":"number",
            "description":"The promotion attribute weight factor non-qualifying attribute is used to decide whether to generate qualifying or non-qualifying points of each type, when the weight factor attribute is specified. This attribute has a dependency on the Weight Factor attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PickList":{
            "maxLength":75,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RetEffFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The date when the attribute can be used in promotions. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RptExpPdUOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unit of measure (UOM) for the time period until the expired points can be reactivated. The accepted values are Years, Months, Days, and so on. For example, if the reactivation expiry period is one year, then the unit of measure (UOM) is Year and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostperPoint":{
            "type":"number",
            "description":"The cost for each point. If you want to allow the product to be redeemed for a combination of points and currency, then enter the amount of money assigned as the cash value of one point. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MergeActionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The promotion attribute merge action specifies how the program handles the attribute during a member merge. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadonlyFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute specifies whether the promotion attribute is editable or not. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PickField":{
            "maxLength":75,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QualPointFlg":{
            "maxLength":1,
            "type":"string",
            "description":"The boolean attribute that indicates that the points accrued when the promotion are applied towards earning tier status, but that cannot be redeemed for rewards. The default value is N. There is no dependency or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The promotion attribute object version number. Oracle Loyalty Cloud sets this attribute. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "DisplayName":{
            "maxLength":30,
            "type":"string",
            "description":"The promotion attribute display name that is displayed on the UI. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TierClassId":{
            "type":"integer",
            "description":"The primary attribute of the loyalty tier class that indicates the class where a specific tier falls. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataTypeName":{
            "type":"string",
            "description":"The promotion attribute data type name 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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpiryBasisCode":{
            "maxLength":30,
            "type":"string",
            "description":"The basis for point or voucher expiry. The accepted values are Period (expires after a period of time) or Date (expires on a specific date). There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumReactivatnQuantity":{
            "type":"number",
            "description":"The minimum points required to reactive the expired points, so they can be used for redemption. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PickApplet":{
            "maxLength":75,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryAlignCode":{
            "maxLength":30,
            "type":"string",
            "description":"The details pertaining to the calculation of the expiry of points. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyExchDt":{
            "type":"string",
            "description":"The date when the promotion attribute currency exchange takes place. This attribute displays the date of the currency exchange during promotion attributes creation. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RptExpPeriodLen":{
            "type":"number",
            "description":"The time period until the expired points can be reactivated. For example, if the reactivation expiry period is one year, then the time period length is 1 and the expired points can be reactivated after a period of one year from the date of expiry. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccntActCode":{
            "maxLength":30,
            "type":"string",
            "description":"The promotion attribute account activity code. If this option is specified, points expire if there is no activity of the type for the point type, within the period specified. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpiryDayCode":{
            "maxLength":30,
            "type":"string",
            "description":"The day of the month when the points expire if the expiry basis is set to Date. The attribute has a dependency on the Expiry Basis Code attribute. There is no default value or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LoyAttrdefnBId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrgFormulaId":{
            "type":"integer",
            "description":"The program formula identifier that is available for use by a promotion only if it is associated with the same program as the program for the promotion. The formula can be used in criteria for comparisons and\nin actions for assigning values or updating attributes with the formula value. There is no default value, dependency, or limitation associated with this attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActiveFlg":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpPeriodLen":{
            "type":"number",
            "description":"The promotion attribute expiry period length is used to specify a length of time after when points expire. For example, if the points expire two years after they are earned, then the length is set to 2. After the points expire, the member can no longer exchange them for rewards. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DescriptionText":{
            "maxLength":1000,
            "type":"string",
            "description":"The additional information pertaining to the attributes being used in the promotion criteria. There is no dependency or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusSvcName":{
            "maxLength":75,
            "type":"string",
            "description":"The external business service that can be called in a promotion to evaluate the business criteria. There is no default value, dependency, or limitation associated with this attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top

Examples

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

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

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

Example of Response Header

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

Example of Response Body

{
  "items" : [ {
    "LoyPromoId" : 300100125457378,
    "CreatedBy" : "LOY_ADMIN_AUTO_QA4",
    "LastUpdatedBy" : "LOY_ADMIN_AUTO_QA4",
    "LastUpdateLogin" : "6831F8A2E3F85B0CE05334C4F00A812D",
    "CreationDate" : "2018-03-24T23:36:08.845+00:00",
    "LastUpdateDate" : "2018-03-24T23:36:09.152+00:00",
    "ConflictId" : 1,
    "ObjectVersionNumber" : 1,
    "ActiveFlg" : "N",
    "AdministratorFlg" : "Y",
    "AlwaysApplyFlg" : "Y",
    "ApplyToTiersFlg" : "Y",
    "AvlToProcflwFlg" : "Y",
    "BasePromoFlg" : "N",
    "BUId" : 0,
    "DescriptionText" : null,
    "EffVchrPrdTpCode" : null,
    "EffVchrPrdVal" : null,
    "EndDt" : null,
    "ExportFlg" : "Y",
    "FinalExecDt" : null,
    "LoyProgId" : 300100125457351,
    "MktgOffrId" : null,
    "Name" : "Auto Miles6bc34522586_Base",
    "NumberTimes" : null,
    "OptinEndDt" : null,
    "OptinStartDt" : "2018-03-24T00:00:00+00:00",
    "OptInFlg" : "N",
    "OrderFlg" : "N",
    "PartnerId" : null,
    "PkgAcrlFlg" : "N",
    "PointLimitCode" : null,
    "ProdInclusionCode" : null,
    "PromoNumber" : "0",
    "PrPromoLogoId" : null,
    "PtnrProcDt" : null,
    "PtnrRvwStatCode" : null,
    "PtnrUserId" : null,
    "RuleModelCode" : null,
    "SmDescriptionText" : null,
    "SrcId" : null,
    "SrmRequiredId" : null,
    "StartDt" : "2018-03-24T00:00:00+00:00",
    "TierId" : 300100125457368,
    "MemInclusionId" : null,
    "TierInclusionId" : null,
    "TypeName" : "Tier",
    "SubTypeName" : "300100125457368",
    "ProgramName" : "Auto Miles6bc34522586",
    "links" : [ {
      "rel" : "self",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyPromotions/300100125457378",
      "name" : "loyaltyPromotions",
      "kind" : "item"
    }, {
      "rel" : "canonical",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyPromotions/300100125457378",
      "name" : "loyaltyPromotions",
      "kind" : "item"
    }, {
      "rel" : "lov",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyPromotions/300100125457378/lov/TypeVA",
      "name" : "TypeVA",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyPromotions/300100125457378/lov/SubTypeVA",
      "name" : "SubTypeVA",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyPromotions/300100125457378/child/PromotionAttributes",
      "name" : "PromotionAttributes",
      "kind" : "collection"
    } ]
  },
.
.
.
   {
    "LoyPromoId" : 300100125460943,
    "CreatedBy" : "LOYALTY_PROGRAM_ADMINISTRATOR",
    "LastUpdatedBy" : "LOYALTY_PROGRAM_ADMINISTRATOR",
    "LastUpdateLogin" : "68337C0A86AF559FE05334C4F00A17C0",
    "CreationDate" : "2018-03-25T01:30:22+00:00",
    "LastUpdateDate" : "2018-03-25T01:33:04.843+00:00",
    "ConflictId" : 0,
    "ObjectVersionNumber" : 2,
    "ActiveFlg" : "Y",
    "AdministratorFlg" : "N",
    "AlwaysApplyFlg" : "N",
    "ApplyToTiersFlg" : "N",
    "AvlToProcflwFlg" : "N",
    "BasePromoFlg" : "N",
    "BUId" : 0,
    "DescriptionText" : null,
    "EffVchrPrdTpCode" : null,
    "EffVchrPrdVal" : null,
    "EndDt" : "2019-03-24T00:00:00+00:00",
    "ExportFlg" : "N",
    "FinalExecDt" : null,
    "LoyProgId" : 300100125460682,
    "MktgOffrId" : null,
    "Name" : "AutoPromob5141435889Accrual",
    "NumberTimes" : null,
    "OptinEndDt" : null,
    "OptinStartDt" : "2018-03-25T00:00:00+00:00",
    "OptInFlg" : "N",
    "OrderFlg" : "N",
    "PartnerId" : null,
    "PkgAcrlFlg" : "N",
    "PointLimitCode" : null,
    "ProdInclusionCode" : null,
    "PromoNumber" : "0",
    "PrPromoLogoId" : null,
    "PtnrProcDt" : null,
    "PtnrRvwStatCode" : null,
    "PtnrUserId" : null,
    "RuleModelCode" : null,
    "SmDescriptionText" : null,
    "SrcId" : null,
    "SrmRequiredId" : null,
    "StartDt" : "2018-03-19T00:00:00+00:00",
    "TierId" : null,
    "MemInclusionId" : null,
    "TierInclusionId" : null,
    "TypeName" : "",
    "SubTypeName" : "Product",
    "ProgramName" : "Auto Miles88541044631",
    "links" : [ {
      "rel" : "self",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyPromotions/300100125460943",
      "name" : "loyaltyPromotions",
      "kind" : "item"
    }, {
      "rel" : "canonical",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyPromotions/300100125460943",
      "name" : "loyaltyPromotions",
      "kind" : "item"
    }, {
      "rel" : "lov",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyPromotions/300100125460943/lov/TypeVA",
      "name" : "TypeVA",
      "kind" : "collection"
    }, {
      "rel" : "lov",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyPromotions/300100125460943/lov/SubTypeVA",
      "name" : "SubTypeVA",
      "kind" : "collection"
    }, {
      "rel" : "child",
      "href" : "https://example.com:port/crmRestApi/resources/11.13.0.0/loyaltyPromotions/300100125460943/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.0.0/loyaltyPromotions",
    "name" : "loyaltyPromotions",
    "kind" : "collection"
  } ]
}

Back to Top