Loyalty tiers
Get all loyalty tiers
Returns all loyalty tiers of the chain or chains, filtered by loyalty program identifiers and optionally filtered by specific loyalty tier identifiers, activity states, or other filter parameters. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/loyaltyTiers/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 | required, max 1000 items | |
| array of string | optional, max 1000 items | |
| optional, max length 3 months | ||
| optional | Whether to return only active, only deleted or both records. | |
| required | Limitation on the quantity of data returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| required | The loyalty tiers of the loyalty program within the chain. | |
| 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 tier
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the loyalty tier. |
| string | optional | Unique identifier of the chain. |
| required | required | Unique identifier of the loyalty program of that loyalty tier. |
| string | required | Name of the loyalty tier. |
| string | required | Code of the loyalty tier. |
| number | required | Ordering of the loyalty tier. |
Add loyalty tiers
Adds loyalty tiers to a loyalty program of the enterprise chain. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/loyaltyTiers/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 | |
| required, max 1000 items | Loyalty tiers to be added. |
Loyalty tier parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the loyalty program the tier belongs to. |
| string | required, max length 50 characters | Name of the loyalty tier. |
| string | required, max length 50 characters | Code of the loyalty tier. |
| number | required | Ordering of the loyalty program. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| required | Added loyalty tiers. |
Update loyalty tiers
Updates information about the specified loyalty tiers.
Request
[PlatformAddress]/api/connector/v1/loyaltyTiers/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. |
| required, max 1000 items | Loyalty tiers to be updated. |
Loyalty tier update parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the loyalty tier. |
| optional, max length 50 characters | Name of the loyalty tier (or | |
| optional, max length 50 characters | Code of the loyalty tier, (or | |
| optional | Ordering of the loyalty tier, (or |
Response
Property | Type | Contract | Description |
---|---|---|---|
| required | Updated loyalty tiers. |
Delete loyalty tiers
Deletes loyalty tiers.
Request
[PlatformAddress]/api/connector/v1/loyaltyTiers/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 tiers to be deleted. |
Response
Last updated