> For the complete documentation index, see [llms.txt](https://docs.mews.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mews.com/loyalty-partner/glossary.md).

# Glossary

Key terms and data objects used throughout the Loyalty Partner API.

### Customer

A `Customer` object holds personal information about a person, including name, email, and address.

```json
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "birthday": "1985-07-20",
  "phoneNumber": "+9876543210",
  "address": {
    "line1": "456 Oak Avenue",
    "city": "Example City",
    "postalCode": "54321",
    "countryCode": "US"
  }
}
```

### Member

A `Member` is a customer who has a membership in the loyalty system. The membership does not need to be in an enrolled state.

```json
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "birthday": "1985-07-20",
  "phoneNumber": "+9876543210",
  "address": {
    "line1": "456 Oak Avenue",
    "line2": "Suite 2A",
    "city": "Example City",
    "postalCode": "54321",
    "countryCode": "US",
    "countrySubdivisionCode": "NY"
  },
  "membership": {
    "providerMembershipId": "7c86eaaf-3b9c-4af6-a8b7-adb14abf7791",
    "membershipNumber": "MEM123456789",
    "tier": "Platinum",
    "points": 5000,
    "status": "enrolled",
    "expiresAt": "2025-01-14T17:30:00+02:00",
    "deeplinkUrl": "https://example.com/membership/MEM123456789"
  }
}
```

### Membership

A `Membership` object contains details about a customer's membership in the loyalty system, including tier, points, and status.

```json
{
  "providerMembershipId": "7c86eaaf-3b9c-4af6-a8b7-adb14abf7791",
  "membershipNumber": "MEM123456789",
  "tier": "Platinum",
  "points": 5000,
  "status": "enrolled",
  "expiresAt": "2025-01-14T17:30:00+02:00",
  "deeplinkUrl": "https://example.com/membership/MEM123456789"
}
```

### Membership status

The `status` field indicates the current state of a membership:

* `pending` — The enrollment is not yet complete and requires confirmation or further action. A membership with this status contains only `providerMembershipId` and `status`.
* `enrolled` — The membership is active and fully operational.
* `canceled` — The membership has expired or been manually revoked. The membership object retains all fields (tier, points, etc.).
* `declined` — The enrollment request was rejected.
* `notFound` — The membership never existed or was deleted from the partner system. A membership with this status contains only `providerMembershipId` and `status`.

### ProviderMembershipId

The `providerMembershipId` is a unique identifier assigned by the partner loyalty system to identify a specific member. It is used to link or verify membership details. If the `membershipNumber` is already globally unique in your system, it can be used as the `providerMembershipId`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.mews.com/loyalty-partner/glossary.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.