Mews · Schema

Loyalty membership parameters

HospitalityHotelsPMSProperty Management

Properties

Name	Type	Description
AccountId	string	Unique identifier of the customer account.
LoyaltyProgramId	string	Unique identifier of the loyalty program.
IsPrimary	boolean	Defines the primary loyalty membership for the account.
State	object	State of the loyalty membership. The default is `Enrolled`. New Pending Enrolled Canceled Declined
Code	string	Loyalty membership code, such as an identification number printed on a loyalty card visible to the customer.
MembershipNumber	string	Customer-facing membership numbers, e.g., printed on a loyalty card.
Points	integer	The loyalty points for the account in that membership.
ExpirationDate	string	Expiration date of the loyalty membership in UTC timezone in ISO 8601 format.
Url	string	URL of the loyalty membership in external loyalty system.
LoyaltyTierId	string	Unique identifier of the loyalty tier.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/LoyaltyMembershipAddParameters",
  "title": "Loyalty membership parameters",
  "required": [
    "AccountId",
    "IsPrimary",
    "LoyaltyProgramId"
  ],
  "type": "object",
  "properties": {
    "AccountId": {
      "type": "string",
      "description": "Unique identifier of the customer account.",
      "format": "uuid"
    },
    "LoyaltyProgramId": {
      "type": "string",
      "description": "Unique identifier of the loyalty program.",
      "format": "uuid"
    },
    "IsPrimary": {
      "type": "boolean",
      "description": "Defines the primary loyalty membership for the account."
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LoyaltyMembershipStateEnum"
        }
      ],
      "description": "State of the loyalty membership. The default is `Enrolled`.\n\nNew\n\nPending\n\nEnrolled\n\nCanceled\n\nDeclined",
      "nullable": true
    },
    "Code": {
      "maxLength": 255,
      "type": "string",
      "description": "Loyalty membership code, such as an identification number printed on a loyalty card visible to the customer.",
      "nullable": true,
      "deprecated": true,
      "x-deprecatedMessage": "Use `MembershipNumber` instead."
    },
    "MembershipNumber": {
      "maxLength": 255,
      "type": "string",
      "description": "Customer-facing membership numbers, e.g., printed on a loyalty card.",
      "nullable": true
    },
    "Points": {
      "type": "integer",
      "description": "The loyalty points for the account in that membership.",
      "format": "int32",
      "nullable": true
    },
    "ExpirationDate": {
      "type": "string",
      "description": "Expiration date of the loyalty membership in UTC timezone in ISO 8601 format.",
      "format": "date",
      "nullable": true
    },
    "Url": {
      "type": "string",
      "description": "URL of the loyalty membership in external loyalty system.",
      "format": "uri",
      "nullable": true
    },
    "LoyaltyTierId": {
      "type": "string",
      "description": "Unique identifier of the loyalty tier.",
      "format": "uuid",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "LoyaltyMembershipAddParameters"
}