Loyalty Accounts

V4

The Loyalty Account endpoints provide access to account information stored within the loyalty program. This information is stored in Kobie as well as an internal LoyaltyAccount.


Endpoints

Verb Endpoint Description
GET /v4/loyalty-accounts/{loyalty-account-id} Get Loyalty Account.
GET /v4/loyalty-accounts/email-{email-address} Get Loyalty Account by Email.
GET /v4/loyalty-accounts/phone-{phone} Get Loyalty Account by mobile phone number.
DELETE /v4/amc-accounts/{amc-account-id}/loyalty Unlinks the loyalty account from the AMC account. Closes the loyalty account.

Loyalty Account


Loyalty Account Properties

Name Description
address The current address of the loyalty account holder.
loyaltyAccountId The id of the loyalty account.
cardNumber The card number associated with the loyalty account.
email The current email of the loyalty account holder.
firstName The first name of the loyalty account holder.
middleInitial The middle initial of the loyalty account holder.
lastName The last name of the loyalty account holder.
ssn The social security number of the loyalty account holder.
gender The gender of the loyalty account holder.
birthDate The birth date of the loyalty account holder.
status The current loyalty account status.
  • Active
  • Inactive
  • Closed
statusInfo The current loyalty account sub-status
  • Active
  • Not Activated
  • Closed
  • Fraud
  • Lost/Stolen
  • Expired
  • Expiring
  • Cancelled
  • Suspended
mobilePhoneNumber The current phone number of the loyalty account holder.
favoriteTheatreId The preferred theatre id of the loyalty account holder.
areTermsAndConditionsAccepted Whether or not the terms and conditions have been accepted.
termsAndConditionsAcceptedVersion The version of the terms and conditions that were accepted.
acceptedTermsAndConditionsDate The date when the terms and conditions were accepted.
numberOfCardsIssued The number of cards that are associated with the loyalty account.
activationType The type of activation of the loyalty account.
  • ASSO
  • WELC
activationDate The date that the loyalty account was activiated.
isEarn Whether or not the loyalty account is earn enabled.
isRedeem Whether or not the loyalty account is redeem enabled.
enrollDate The enrollment date of the loyalty account.
receivesNotificationsViaEmail Whether or not the loyalty account holder wants to receive notifications via email.
receivesNotificationsViaMobile Whether or not the loyalty account holder wants to receive notifications via text.
receivesOffersViaEmail Whether or not the loyalty account holder wants to receive offers via email.
receivesOffersViaMobile Whether or not the loyalty account holder wants to receive offers via text.
receivesWeeklyEmails Whether or not the loyalty account holder wants to receive email updates.


Loyalty Account Links

Relation Description Methods Templated
self This loyalty account GET No

Address


Address Properties

Name Description
address1 The street address of the account holder.
address2 The secondary street address of the account holder, usually a suite or apartment number.
city The city or municipality of the account holder.
postalCode The zip or postal code of the account holder.
state The state or province of the account holder.

LoyaltyEarnProduct


LoyaltyEarnProduct Properties

Name Description
productId The id of the earn product.
description The description of the earn product.
category The category of the earn product.
subCategory The sub category of the earn product.
class The class of the earn product.


Examples

Get the loyalty account with the given id.
GET  /v4/loyalty-accounts/123456789123456

Response

{
  "address": {
    "address1": "11500 Ash St",
    "address2": "Suite 250",
    "city": "Leawood",
    "state": "Kansas",
    "postalCode": "66211"
  },
  "loyaltyAccountId": 802300000006406,
  "cardNumber": "1101000112007386",
  "email": "developers@amctheatres.com",
  "firstName": "Ima",
  "middleInitial": "W",
  "lastName": "Developer",
  "ssn": 0,
  "gender": "M",
  "birthDate": "1984-02-13T00:00:00",
  "status": "Active",
  "statusInfo": "Active",
  "mobilePhoneNumber": "9135551212",
  "favoriteTheatreId": 610,
  "areTermsAndConditionsAccepted": true,
  "termsAndConditionsAcceptedVersion": 3,
  "acceptedTermsAndConditionsDate": "2016-10-04T13:47:59",
  "numberOfCardsIssued": 1,
  "activationType": "WELC",
  "activationDate": "2016-10-04T00:00:00",
  "isEarn": true,
  "isRedeem": true,
  "enrollDate": "2017-02-15T13:30:00.2",
  "receivesNotificationsViaEmail": false,
  "receivesNotificationsViaMobile": false,
  "receivesOffersViaEmail": false,
  "receivesOffersViaMobile": false,
  "receivesWeeklyEmails": false,
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v4/loyalty-accounts/802300000006406",
      "templated": false
    }
  }
}
Get the loyalty account with the given email
GET  /v4/loyalty-accounts/email-insider@amctheatres.com

Response

{
  "address": {
    "address1": "11500 Ash St",
    "address2": "Suite 250",
    "city": "Leawood",
    "state": "Kansas",
    "postalCode": "66211"
  },
  "loyaltyAccountId": 802300000006406,
  "cardNumber": "1101000112007386",
  "email": "developers@amctheatres.com",
  "firstName": "Ima",
  "middleInitial": "W",
  "lastName": "Developer",
  "ssn": 0,
  "gender": "M",
  "birthDate": "1984-02-13T00:00:00",
  "status": "Active",
  "statusInfo": "Active",
  "mobilePhoneNumber": "9135551212",
  "favoriteTheatreId": 610,
  "areTermsAndConditionsAccepted": true,
  "termsAndConditionsAcceptedVersion": 3,
  "acceptedTermsAndConditionsDate": "2016-10-04T13:47:59",
  "numberOfCardsIssued": 1,
  "activationType": "WELC",
  "activationDate": "2016-10-04T00:00:00",
  "isEarn": true,
  "isRedeem": true,
  "enrollDate": "2017-02-15T13:30:00.2",
  "receivesNotificationsViaEmail": false,
  "receivesNotificationsViaMobile": false,
  "receivesOffersViaEmail": false,
  "receivesOffersViaMobile": false,
  "receivesWeeklyEmails": false,
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v4/loyalty-accounts/802300000006406",
      "templated": false
    }
  }
}
Get the loyalty account with the given mobile phone number
GET  /v4/loyalty-accounts/phone-9135551212

Response

{
  "address": {
    "address1": "11500 Ash St",
    "address2": "Suite 250",
    "city": "Leawood",
    "state": "Kansas",
    "postalCode": "66211"
  },
  "loyaltyAccountId": 802300000006406,
  "cardNumber": "1101000112007386",
  "email": "developers@amctheatres.com",
  "firstName": "Ima",
  "middleInitial": "W",
  "lastName": "Developer",
  "ssn": 0,
  "gender": "M",
  "birthDate": "1984-02-13T00:00:00",
  "status": "Active",
  "statusInfo": "Active",
  "mobilePhoneNumber": "9135551212",
  "favoriteTheatreId": 610,
  "areTermsAndConditionsAccepted": true,
  "termsAndConditionsAcceptedVersion": 3,
  "acceptedTermsAndConditionsDate": "2016-10-04T13:47:59",
  "numberOfCardsIssued": 1,
  "activationType": "WELC",
  "activationDate": "2016-10-04T00:00:00",
  "isEarn": true,
  "isRedeem": true,
  "enrollDate": "2017-02-15T13:30:00.2",
  "receivesNotificationsViaEmail": false,
  "receivesNotificationsViaMobile": false,
  "receivesOffersViaEmail": false,
  "receivesOffersViaMobile": false,
  "receivesWeeklyEmails": false,
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v4/loyalty-accounts/802300000006406",
      "templated": false
    }
  }
}
Delete an existing Loyalty Account
DELETE  /v4/amc-accounts/654321/loyalty

Response

HTTP/1.1 200 OK