Members

Operations related to working with customers who are members of provider's loyalty program.

Search members

post

Search members based on customer information provided by Mews PMS.

Mews PMS will use this operation to display existing members based on customer-provided data. All available customer data is sent.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token provided by loyalty program provider.

Header parameters

Accept-LanguagestringOptional

Language preference for error messages and descriptions. If not provided, English will be used as the default language.

Example: en-US

Body

application/json

Request payload for searching loyalty program members based on customer information from Mews PMS.

mewsEnterpriseIdstring · uuidRequired

The identifier of the Mews enterprise on whose behalf the request has been made.

Example: 123e4567-e89b-12d3-a456-426614174000

providerEnterpriseIdstringOptional

An optional identifier of the enterprise from the loyalty provider on whose behalf the request has been made.

Example: ENT-9876-AZ

Responses

200

Search result with list of matching members.

application/json

Response payload containing search results with matching loyalty program members.

isPartialResultbooleanRequired

If the number of matching results exceeds the allowed maximum number of result items (10), set isPartialResult to true to indicate an incomplete result set.

400

Bad Request - Returned when the request is invalid, such as missing required fields or containing data in an incorrect format (e.g., an improperly formatted email).

application/problem+json

401

Unauthorized

application/problem+json

408

Request Timeout

application/problem+json

422

Unprocessable Content - Used when the request is syntactically valid but fails due to business logic constraints, such as required parameter combinations or insufficient search parameters.

application/problem+json

500

Internal Server Error

application/problem+json

post/members/search

HTTPcURLJavaScriptPython

POST /members/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "mewsEnterpriseId": "123e4567-e89b-12d3-a456-426614174000",
  "providerEnterpriseId": "ENT-9876-AZ",
  "memberFilter": {
    "email": "[e-mail]",
    "firstName": "John",
    "lastName": "Doe"
  }
}

{
  "isPartialResult": false,
  "data": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "membership": {
        "providerMembershipId": "MEMB-123456-ABC123",
        "membershipNumber": "M-123-72ca09f4",
        "status": "enrolled"
      }
    }
  ]
}

Enroll a customer

post

Enrolls a customer from Mews into the provider's loyalty system by creating a new loyalty membership.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer token provided by loyalty program provider.

Header parameters

Accept-LanguagestringOptional

Language preference for error messages and descriptions. If not provided, English will be used as the default language.

Example: en-US

Body

application/json

Request payload for enrolling a customer from Mews into the provider's loyalty program.

mewsEnterpriseIdstring · uuidRequired

The identifier of the Mews enterprise on whose behalf the request has been made.

Example: 123e4567-e89b-12d3-a456-426614174000

providerEnterpriseIdstringOptional

An optional identifier of the enterprise from the loyalty provider on whose behalf the request has been made.

Example: ENT-9876-AZ

Responses

200

Enrollment was accepted, member is successfully enrolled or their membership is pending.

application/json

Response payload containing the newly created or updated membership information after enrollment.

400

Bad Request - Returned when the enrollment request is invalid, such as missing required fields or containing data in an incorrect format.

application/problem+json

401

Unauthorized

application/problem+json

408

Request Timeout

application/problem+json

422

Unprocessable Entity

application/problem+json

500

Internal Server Error

application/problem+json

post/members

HTTPcURLJavaScriptPython

POST /members HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "mewsEnterpriseId": "123e4567-e89b-12d3-a456-426614174000",
  "providerEnterpriseId": "ENT-9876-AZ",
  "customer": {
    "mewsCustomerId": "550e8400-e29b-41d4-a716-446655440000",
    "firstName": "John",
    "lastName": "Doe",
    "address": {
      "city": "New York"
    }
  }
}

{
  "data": {
    "providerMembershipId": "MEMB-123456-ABC123",
    "membershipNumber": "M-123-72ca09f4",
    "status": "pending"
  }
}