# 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](https://docs.mews.com/connector-api/guidelines/pagination) and supports [Portfolio Access Tokens](https://docs.mews.com/connector-api/concepts/multi-property).

### Request

`[PlatformAddress]/api/connector/v1/loyaltyTiers/getAll`

```javascript
{
  "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",
    "da34b396-41f7-47f6-8847-aecf00a3f19e"
  ],
  "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
  }
}
```

| 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                                                                        | required, max 1000 items      | Unique identifiers of [Loyalty programs](#loyalty-program).                                                                    |
| `LoyaltyTierIds`    | array of string                                                                        | optional, max 1000 items      | Unique identifiers of [Loyalty tiers](#loyalty-tier).                                                                          |
| `ActivityStates`    | array of [Activity state](https://docs.mews.com/connector-api/_objects#activity-state) | optional                      | Whether to return only active, only deleted or both records.                                                                   |
| `UpdatedUtc`        | [Time interval](https://docs.mews.com/connector-api/_objects#time-interval)            | optional, max length 3 months | Interval of `Loyalty tier` last update date and time.                                                                          |
| `Limitation`        | [Limitation](https://docs.mews.com/connector-api/guidelines/pagination#limitation)     | required                      | Limitation on the quantity of data returned.                                                                                   |

### Response

```javascript
{
  "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"
}
```

| Property       | Type                                   | Contract                 | Description                                                                                                                                                                        |
| -------------- | -------------------------------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `LoyaltyTiers` | array of [Loyalty tier](#loyalty-tier) | required, max 1000 items | The loyalty tiers of the loyalty program within the chain.                                                                                                                         |
| `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 tier

| Property           | Type    | Contract                           | Description                                                    |
| ------------------ | ------- | ---------------------------------- | -------------------------------------------------------------- |
| `Id`               | string  | required                           | Unique identifier of the loyalty tier.                         |
| `LoyaltyProgramId` | string  | required                           | Unique identifier of the loyalty program of that loyalty tier. |
| `Name`             | string  | required, max length 50 characters | Name of the loyalty tier.                                      |
| `Code`             | string  | required, max length 50 characters | Code of the loyalty tier.                                      |
| `Ordering`         | integer | 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](https://docs.mews.com/connector-api/concepts/multi-property).

### Request

`[PlatformAddress]/api/connector/v1/loyaltyTiers/add`

```javascript
{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "LoyaltyTiers": [
    {
      "LoyaltyProgramId": "f701dafb-5765-4cf4-b1dd-1f602a740ae5",
      "Name": "Platinum",
      "Code": "P1",
      "Ordering": 1
    }
  ],
  "ChainId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

| 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                 | Unique identifier of the chain. Required when using [Portfolio Access Tokens](https://docs.mews.com/connector-api/concepts/multi-property), ignored otherwise. |
| `LoyaltyTiers` | array of [Loyalty tier add parameters](#loyalty-tier-add-parameters) | required, max 1000 items | Loyalty tiers to be added.                                                                                                                                     |

#### Loyalty tier add parameters

| Property           | Type    | Contract                           | Description                                                   |
| ------------------ | ------- | ---------------------------------- | ------------------------------------------------------------- |
| `LoyaltyProgramId` | string  | required                           | Unique identifier of the loyalty program the tier belongs to. |
| `Name`             | string  | required, max length 50 characters | Name of the loyalty tier.                                     |
| `Code`             | string  | required, max length 50 characters | Code of the loyalty tier.                                     |
| `Ordering`         | integer | required                           | Ordering of the loyalty tier.                                 |

### Response

```javascript
{
  "LoyaltyTiers": [
    {
      "Id": "69eedfd2-6f25-42fc-b3c8-39df70f85e37",
      "LoyaltyProgramId": "f701dafb-5765-4cf4-b1dd-1f602a740ae5",
      "Name": "Platinum",
      "Code": "P1",
      "Ordering": 1
    }
  ]
}
```

| Property       | Type                                   | Contract                 | Description                                                |
| -------------- | -------------------------------------- | ------------------------ | ---------------------------------------------------------- |
| `LoyaltyTiers` | array of [Loyalty tier](#loyalty-tier) | required, max 1000 items | The loyalty tiers of the loyalty program within the chain. |

## Update loyalty tiers

Updates information about the specified loyalty tiers.

### Request

`[PlatformAddress]/api/connector/v1/loyaltyTiers/update`

```javascript
{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "LoyaltyTierUpdates": [
    {
      "LoyaltyTierId": "69eedfd2-6f25-42fc-b3c8-39df70f85e37",
      "Name": {
        "Value": "Platinum"
      },
      "Code": {
        "Value": "P1"
      },
      "Ordering": {
        "Value": 1
      }
    }
  ]
}
```

| 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. |
| `LoyaltyTierUpdates` | array of [Loyalty tier update parameters](#loyalty-tier-update-parameters) | required, max 1000 items | Loyalty tiers to be updated.                |

#### Loyalty tier update parameters

| Property        | Type                                                                                      | Contract                           | Description                                                                      |
| --------------- | ----------------------------------------------------------------------------------------- | ---------------------------------- | -------------------------------------------------------------------------------- |
| `LoyaltyTierId` | string                                                                                    | required                           | Unique identifier of the loyalty tier.                                           |
| `Name`          | [String update value](https://docs.mews.com/connector-api/_objects#string-update-value)   | optional, max length 50 characters | Name of the loyalty tier (or `null` if the name should not be updated).          |
| `Code`          | [String update value](https://docs.mews.com/connector-api/_objects#string-update-value)   | optional, max length 50 characters | Code of the loyalty tier, (or `null` if the code should not be updated).         |
| `Ordering`      | [Integer update value](https://docs.mews.com/connector-api/_objects#integer-update-value) | optional                           | Ordering of the loyalty tier, (or `null` if the ordering should not be updated). |

### Response

```javascript
{
  "LoyaltyTiers": [
    {
      "Id": "69eedfd2-6f25-42fc-b3c8-39df70f85e37",
      "LoyaltyProgramId": "f701dafb-5765-4cf4-b1dd-1f602a740ae5",
      "Name": "Platinum",
      "Code": "P1",
      "Ordering": 1
    }
  ]
}
```

| Property       | Type                                   | Contract                 | Description                                                |
| -------------- | -------------------------------------- | ------------------------ | ---------------------------------------------------------- |
| `LoyaltyTiers` | array of [Loyalty tier](#loyalty-tier) | required, max 1000 items | The loyalty tiers of the loyalty program within the chain. |

## Delete loyalty tiers

Deletes loyalty tiers.

### Request

`[PlatformAddress]/api/connector/v1/loyaltyTiers/delete`

```javascript
{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "LoyaltyTierIds": [
    "69eedfd2-6f25-42fc-b3c8-39df70f85e37",
    "3cad97ef-5257-4ced-8599-8e6bbd33331f"
  ]
}
```

| 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.           |
| `LoyaltyTierIds` | array of string | required, max 1000 items | Unique identifier of the loyalty tiers to be deleted. |

### Response

```javascript
{}
```