Loyalty programs
Get all loyalty programs
Returns all loyalty programs of the enterprise (in the given activity state), optionally filtered by specific loyalty program identifiers or other filter parameters. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/loyaltyPrograms/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | optional, max 1000 items | Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token. |
| array of string | optional, max 1000 items | Unique identifiers of Loyalty programs. |
| optional, max length 3 months | Interval of Loyalty program creation date and time. | |
| optional, max length 3 months | Interval of Loyalty program last update date and time. | |
| array of string Activity state | optional | Whether to return only active, only deleted or both records. |
| required | Limitation on the quantity of data returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Loyalty program | required | The loyalty programs of the enterprise. |
| string | optional | Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned. |
Loyalty program
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the loyalty program. |
| string | optional | Unique identifier of the chain. |
| string | required | Name of the loyalty program. |
| string | required | Code of the loyalty program. |
| string | required | |
| string | required |
Loyalty program type
Hotel
ExternalPartner
SoftBrand
Loyalty program subscription
Free
Paid
Add loyalty programs
Adds loyalty programs to the enterprise. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/loyaltyPrograms/add
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise. |
| array of Loyalty program parameters | required, max 1000 items | Loyalty programs to be added. |
Loyalty program parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the chain whose member the enterprise is. |
| string | required | Name of the loyalty program. |
| string | required | Code of the loyalty program. |
| string Loyalty program type | required | Type of the loyalty program. |
| string Loyalty program subscription | required | Subscription of the loyalty program. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Loyalty program | required | Added loyalty programs. |
Update loyalty programs
Updates information about the specified loyalty programs. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/loyaltyPrograms/update
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| string | optional | Unique identifier of the chain. Required when using Portfolio Access Tokens, ignored otherwise. |
| array of Loyalty program update parameters | required, max 1000 items | Loyalty programs to be updated. |
Loyalty program update parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the loyalty program. |
| optional | Name of the loyalty program (or | |
| optional | Type of the loyalty program, (or | |
| optional | Subscription of the loyalty program, (or |
Loyalty program type update
| Property | Type | Contract | Description | | Value
| string Loyalty program type | required | Type of the loyalty program. |
Loyalty program subscription update
| Property | Type | Contract | Description | | Value
| string Loyalty program subscription | required | Subscription of the loyalty program. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Loyalty program | required | Updated loyalty programs. |
Delete loyalty programs
Deletes loyalty programs. Note that a loyalty program containing active memberships cannot be deleted.
Request
[PlatformAddress]/api/connector/v1/loyaltyPrograms/delete
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | required, max 1000 items | Unique identifier of the loyalty programs to be deleted. |
Response
Last updated