Skip to content

Latest commit

 

History

History
274 lines (225 loc) · 10 KB

loyaltyprograms.md

File metadata and controls

274 lines (225 loc) · 10 KB
Raw

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

{
    "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 Unique identifiers of Loyalty programs.
CreatedUtc Time interval optional, max length 3 months Interval of Loyalty program creation date and time.
UpdatedUtc Time interval optional, max length 3 months Interval of Loyalty program last update date and time.
ActivityStates array of string Activity state optional Whether to return only active, only deleted or both records.
Limitation 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 array of Loyalty program 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 Loyalty program type string required
Subscription Loyalty program subscription string required

Loyalty program type

  • Hotel
  • ExternalPartner
  • SoftBrand

Loyalty program subscription

  • Free
  • Paid

Add loyalty programs

Adds loyalty programs to the enterprise.

Request

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

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "LoyaltyPrograms": [
        {
            "DataClusterId": "8ddea57b-6a5c-4eec-8c4c-24467dce118e",
            "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.
LoyaltyPrograms array of Loyalty program parameters required, max 1000 items Loyalty programs to be added.

Loyalty program parameters

Property Type Contract Description
DataClusterId string required Unique identifier of the chain whose member the enterprise is.
Name string required Name of the loyalty program.
Code string required Code of the loyalty program.
Type string Loyalty program type required Type of the loyalty program.
Subscription string 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 array of Loyalty program required Added loyalty programs.

Update loyalty programs

Updates information about the specified loyalty programs.

Request

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

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "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.
LoyaltyProgramUpdates array of Loyalty program update parameters 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 String update value optional Name of the loyalty program (or null if the name should not be updated).
Type Loyalty program type update optional Type of the loyalty program, (or null if the type should not be updated).
Subscription Loyalty program subscription update optional Subscription of the loyalty program, (or null if the subscription should not be updated).

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

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

{
    "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

{}