Get all loyalty tiers
POST /api/connector/v1/loyaltyTiers/getAll
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 Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifiers of the chain. If not specified, the operation returns data for all chains within scope of the Access Token.
Unique identifiers of Loyalty programs.
Unique identifiers of Loyalty tiers.
Whether to return only active, only deleted or both records.
Interval of Loyalty tier last update date and time.
object
Limitation on the quantity of data returned.
object
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "ChainIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "5fcd1933-22f2-40b9-84da-7db04cbecec2" ], "LoyaltyProgramIds": [ "f701dafb-5765-4cf4-b1dd-1f602a740ae5" ], "LoyaltyTierIds": [ "69eedfd2-6f25-42fc-b3c8-39df70f85e37", "3cad97ef-5257-4ced-8599-8e6bbd33331f" ], "ActivityStates": [ "Active" ], "UpdatedUtc": { "StartUtc": "2022-10-10T00:00:00Z", "EndUtc": "2022-10-17T00:00:00Z" }, "Limitation": { "Count": 100 }}Responses
Section titled “ Responses ”OK
object
The loyalty tiers of the loyalty program within the chain.
object
Unique identifier of the loyalty tier.
Unique identifier of the loyalty program of that loyalty tier.
Name of the loyalty tier.
Code of the loyalty tier.
Ordering of the loyalty tier.
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.
Example
{ "LoyaltyTiers": [ { "Id": "69eedfd2-6f25-42fc-b3c8-39df70f85e37", "LoyaltyProgramId": "f701dafb-5765-4cf4-b1dd-1f602a740ae5", "Name": "Platinum", "Code": "P1", "Ordering": 1 }, { "Id": "3cad97ef-5257-4ced-8599-8e6bbd33331f", "LoyaltyProgramId": "f701dafb-5765-4cf4-b1dd-1f602a740ae5", "Name": "Silver", "Code": "S1", "Ordering": 2 } ], "Cursor": "3cad97ef-5257-4ced-8599-8e6bbd33331f"}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.