Loyalty memberships
Get all loyalty memberships
Returns all loyalty memberships of the enterprise, optionally filtered by specific loyalty membership identifiers, activity states, or other filter parameters. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/loyaltyMemberships/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 memberships. |
| array of string | optional, max 1000 items | Unique identifiers of Loyalty programs. |
| array of string | optional, max 1000 items | |
| array of string Loyalty membership state | optional | States of the loyalty memberships. |
| optional, max length 3 months | Interval of Loyalty membership creation date and time. | |
| optional, max length 3 months | Interval of Loyalty membership 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. |
Activity state
Active
- active records (the validity might be restricted by another parameter i.e. interval).Deleted
- deleted records.
Loyalty membership state
New
Pending
Enrolled
Canceled
Declined
...
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Loyalty memberships | required | The loyalty memberships 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 membership
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the loyalty membership. |
| string | optional | Unique identifier of the chain. |
| string | required | Unique identifier of the loyalty program. |
| string | required | Unique identifier of the customer account. |
| string | optional | Code of the loyalty membership. |
| boolean | required | Defines the primary loyalty membership. |
| integer | optional | The loyalty points for the account in that membership. |
| string | optional | Expiration date of the loyalty membership in UTC timezone in ISO 8601 format. |
| string | optional | Url of the loyalty membership. |
| string | optional | Unique identifier of the loyalty tier. |
| required | State of the loyalty membership. | |
| required | The profile data of the user who created the loyalty membership. | |
| required | The profile data of the user who updated the loyalty membership. |
Profile data
Property | Type | Contract | Description |
---|---|---|---|
| string Profile data discriminator | required | Type of the profile data (e.g. |
| optional | Enterprise profile data. |
Profile data discriminator
Personal
Enterprise
Platform
Static
Integration
...
Enterprise profile data
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the profile. |
Add loyalty memberships
Adds loyalty memberships to the enterprise. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/loyaltyMemberships/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 membership parameters | required, max 1000 items | Loyalty memberships to be added. |
Loyalty membership parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the loyalty program. |
| string | required | Unique identifier of the customer account. |
| string | optional | Code of the loyalty membership. |
| boolean | required | Defines the primary loyalty membership for the account. |
| integer | optional | The loyalty points for the account in that membership. |
| string | optional | Expiration date of the loyalty membership in UTC timezone in ISO 8601 format. |
| string | optional | URL of the loyalty membership in external loyalty system. |
| string | optional | Unique identifier of the loyalty tier. |
| optional | State of the loyalty membership. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Loyalty membership | required | Added loyalty memberships. |
Update loyalty memberships
Updates information about the specified loyalty memberships. Note this operation supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/loyaltyMemberships/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 membership update parameters | required, max 1000 items | Loyalty memberships to be updated. |
Loyalty membership update parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the loyalty membership. |
| optional | Unique identifier of the loyalty program (or | |
| optional | Boolean value defining the primary loyalty membership for the account. (or | |
| optional | The loyalty points the account has in the loyalty membership (or | |
| optional | Code of the loyalty membership. (or | |
| optional | Expiration date of the loyalty membership in UTC timezone in ISO 8601 format (or | |
| optional | URL of the loyalty membership (or | |
| optional | Unique identifier of the loyalty tier (or | |
| optional | State of the loyalty membership, (or |
Loyalty membership state update
Property | Type | Contract | Description |
---|---|---|---|
| required | State of the loyalty membership. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Loyalty membership | required | Added loyalty memberships. |
Delete loyalty memberships
Deletes loyalty memberships.
Request
[PlatformAddress]/api/connector/v1/loyaltyMemberships/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 memberships to be deleted. |
Response
Last updated