Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • Get all loyalty programs
  • Request
  • Response
  • Add loyalty programs
  • Request
  • Response
  • Update loyalty programs
  • Request
  • Response
  • Delete loyalty programs
  • Request
  • Response

Was this helpful?

  1. API Operations

Loyalty programs

PreviousLoyalty membershipsNextLoyalty tiers

Last updated 4 months ago

Was this helpful?

Get all loyalty programs

Returns all loyalty programs of the enterprise, optionally filtered by specific loyalty program identifiers, activity states, or other filter parameters. Note this operation uses and supports .

Request

[PlatformAddress]/api/connector/v1/loyaltyPrograms/getAll

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ChainIds": [
        "1df21f06-0cfc-4960-9c58-a3bf1261663e",
        "5fcd1933-22f2-40b9-84da-7db04cbecec2"
    ],
    "LoyaltyProgramIds": [
        "3ed9e2f3-4bba-4df6-8d41-ab1b009b6425",
        "8a98965a-7c03-48a1-a28c-ab1b009b53c8"
    ],
    "CreatedUtc": {
        "StartUtc": "2022-10-05T00:00:00Z",
        "EndUtc": "2022-10-10T00:00:00Z"
    },
    "UpdatedUtc": {
        "StartUtc": "2022-10-10T00:00:00Z",
        "EndUtc": "2022-10-17T00:00:00Z"
    },
    "ActivityStates": [
        "Active"
    ],
    "Limitation":{ "Count": 100 }
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

ChainIds

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.

LoyaltyProgramIds

array of string

optional, max 1000 items

CreatedUtc

optional, max length 3 months

UpdatedUtc

optional, max length 3 months

ActivityStates

optional

Whether to return only active, only deleted or both records.

Limitation

required

Limitation on the quantity of data returned.

Response

{
    "LoyaltyPrograms": [
        {
            "Id": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
            "ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
            "Name": "Platinum Club",
            "Code": "PC01",
            "Type": "Hotel",
            "Subscription": "Free"
        },
        {
            "Id": "da34b396-41f7-47f6-8847-aecf00a3f19e",
            "ChainId": "5fcd1933-22f2-40b9-84da-7db04cbecec2",
            "Name": "Gold Exclusive Club",
            "Code": "GEC07",
            "Type": "ExternalPartner",
            "Subscription": "Paid"
        }
    ],
    "Cursor": "da34b396-41f7-47f6-8847-aecf00a3f19e"
}
Property
Type
Contract
Description

LoyaltyPrograms

required

The loyalty programs of the enterprise.

Cursor

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

Id

string

required

Unique identifier of the loyalty program.

ChainId

string

optional

Unique identifier of the chain.

Name

string

required

Name of the loyalty program.

Code

string

required

Code of the loyalty program.

Type

string

required

Subscription

string

required

Loyalty program type

  • Hotel

  • ExternalPartner

  • SoftBrand

Loyalty program subscription

  • Free

  • Paid

Add loyalty programs

Request

[PlatformAddress]/api/connector/v1/loyaltyPrograms/add

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
    "LoyaltyPrograms": [
        {
            "Name": "Platinum Club",
            "Code": "PC01",
            "Type": "Hotel",
            "Subscription": "Free"
        }
    ]
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

ChainId

string

optional

LoyaltyPrograms

required, max 1000 items

Loyalty programs to be added.

Loyalty program parameters

Property
Type
Contract
Description

Name

string

required

Name of the loyalty program.

Code

string

required

Code of the loyalty program.

Type

required

Type of the loyalty program.

Subscription

required

Subscription of the loyalty program.

Response

{
    "LoyaltyPrograms": [
		{
            "Id": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
            "Name": "Platinum Club",
            "Code": "PC01",
            "Type": "Hotel",
            "Subscription": "Free"
        }
    ]
}
Property
Type
Contract
Description

LoyaltyPrograms

required

Added loyalty programs.

Update loyalty programs

Request

[PlatformAddress]/api/connector/v1/loyaltyPrograms/update

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ChainId": "1df21f06-0cfc-4960-9c58-a3bf1261663e",
    "LoyaltyProgramUpdates": [
        {
            "LoyaltyProgramId": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
            "Name": {
                "Value": "Platinum Club Extra"
            },
            "Type": {
                "Value": "Hotel"
            },
            "Subscription": {
                "Value": "Free"
            }
        }
    ]
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

ChainId

string

optional

LoyaltyProgramUpdates

required, max 1000 items

Loyalty programs to be updated.

Loyalty program update parameters

Property
Type
Contract
Description

LoyaltyProgramId

string

required

Unique identifier of the loyalty program.

Name

optional

Name of the loyalty program (or null if the name should not be updated).

Type

optional

Type of the loyalty program, (or null if the type should not be updated).

Subscription

optional

Subscription of the loyalty program, (or null if the subscription should not be updated).

Loyalty program type update

Property
Type
Contract
Description

Value

required

Type of the loyalty program.

Loyalty program subscription update

Property
Type
Contract
Description

Value

required

Subscription of the loyalty program.

Response

{
    "LoyaltyPrograms": [
		{
            "Id": "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
            "Name": "Platinum Club Extra",
            "Code": "PC01",
            "Type": "Hotel",
            "Subscription": "Free"
        }
    ]
}
Property
Type
Contract
Description

LoyaltyPrograms

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

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "LoyaltyProgramIds": [
        "a58ff7cb-77e3-495a-bd61-aecf00a3f19d",
		"da34b396-41f7-47f6-8847-aecf00a3f19e"
    ]
}
Property
Type
Contract
Description

ClientToken

string

required

Token identifying the client application.

AccessToken

string

required

Access token of the client application.

Client

string

required

Name and version of the client application.

LoyaltyProgramIds

array of string

required, max 1000 items

Unique identifier of the loyalty programs to be deleted.

Response

{}

Unique identifiers of .

Interval of creation date and time.

Interval of last update date and time.

array of string

array of

Adds loyalty programs to the enterprise. Note this operation supports .

Unique identifier of the chain. Required when using , ignored otherwise.

array of

string

string

array of

Updates information about the specified loyalty programs. Note this operation supports .

Unique identifier of the chain. Required when using , ignored otherwise.

array of

string

string

array of

Pagination
Portfolio Access Tokens
Portfolio Access Tokens
Portfolio Access Tokens
Portfolio Access Tokens
Portfolio Access Tokens
Loyalty programs
Loyalty program
Loyalty program
Loyalty program
Loyalty program type
Loyalty program subscription
Loyalty program parameters
Loyalty program type
Loyalty program subscription
Loyalty program
Loyalty program update parameters
Loyalty program type update
Loyalty program subscription update
Loyalty program type
Loyalty program subscription
Loyalty program
Limitation
Time interval
Time interval
Activity state
String update value