Loyalty Cards

V4

The Loyalty Card endpoints provide access to loyalty card balance information.


Endpoints

Verb Endpoint Description
GET /v4/loyalty-cards/{card-number} Get Loyalty Card.
GET /v4/loyalty-cards?loyalty-account-id={loyalty-account-id}&email={email} Get Loyalty Card.
POST v4/loyalty-cards/{card-number}/earn-for-items Add new earn for items to the given Loyalty Card.
POST v4/loyalty-cards/{card-number}/waive-fees Waive fees associated with the given Loyalty Card.
POST v4/loyalty-cards/validations Validate the given Loyalty Card information.

Loyalty Cards Query Parameters

  • You may optionally supply a loyalty-account-id query string parameter to the Loyalty account id of the Loyalty account for returned card.
  • You may optionally supply a email query string parameter to the email of the Loyalty account for returned card.

Loyalty Account


Loyalty Account Properties

Name Description
balance The current loyalty card balance as a decimal in USD.
pointsEarned The current loyalty card balance as rewards points.
accountType The current loyalty card account type.
  • WebOnly
  • Legacy
  • Insider
  • Premiere
  • Associate
status The current loyalty card status.
  • Active
  • Inactive
  • Closed
statusInfo The current loyalty card sub-status
  • Active
  • Not Activated
  • Closed
  • Fraud
  • Lost/Stolen
  • Expired
  • Expiring
  • Cancelled
  • Suspended
expirationDate Expiration date of the loyalty account


Loyalty Account Links

Relation Description Methods Templated
self This loyalty card GET No

LoyaltyEarnProduct


LoyaltyEarnProduct Properties

Name Description
productId The product id number.
description The product description.
ticketType The type of ticket associated with the earn product.
featureName The name of the movie.
featureId The movie id number.
auditoriumName The name of the auditorium.
price The price of the product.
discountedPrice The discounted price of the product.
categoryName The category of the product.
subCategoryName The sub category of the product.


Examples

Get the loyalty card 1234567891234567
GET  /v4/loyalty-cards/1234567891234567

Response

{
  "balance": 0,
  "pointsEarned": 0,
  "accountType": "Premiere",
  "status": "Active",
  "statusInfo": "Active",
  "expirationDate": "2018-06-20T00:00:00",
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v4/loyalty-cards/1234567891234567",
      "templated": false
    }
  }
}
Get the loyalty card associated with the given email address.
GET  /v4/loyalty-cards?email=amc12345@amctheatres.com

Response

{
  "balance": 0,
  "pointsEarned": 0,
  "accountType": "Premiere",
  "status": "Active",
  "statusInfo": "Active",
  "expirationDate": "2018-06-20T00:00:00",
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v4/loyalty-cards/1234567891234567",
      "templated": false
    }
  }
}
Get the loyalty card with the given Loyalty account id.
GET  /v4/loyalty-cards?loyalty-account-id=123456789012345

Response

{
  "balance": 0,
  "pointsEarned": 0,
  "accountType": "Premiere",
  "status": "Active",
  "statusInfo": "Active",
  "expirationDate": "2018-06-20T00:00:00",
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v4/loyalty-cards/1234567891234567",
      "templated": false
    }
  }
}
Add earn for items to the loyalty card 1234567891234567
POST  /v4/loyalty-cards/1234567891234567/earn-for-items

Request

{
  "total": 100.0,
  "earnItems": [
    {
      "productId": "12345",
      "description": "Item description",
      "ticketType": "Adult",
      "feature": "Hot Pursuit",
      "featureId": "12345",
      "auditoriumId": "8",
      "price": 1.0
    }
  ]
}

Response

HTTP/1.1 200 OK
Waive fees associated with the loyalty card 1234567891234567
POST  /v4/loyalty-cards/1234567891234567/waive-fees

Request

{
  "amount": 10.0
}

Response

HTTP/1.1 200 OK
Validate the loyalty card number 12345678901234
POST  /v4/loyalty-cards/validations

Request

{
  "loyaltyCard": {
    "number": "12345678901234"
  }
}

Response

HTTP/1.1 200 OK
Validate the loyalty card associate
POST  /v4/loyalty-cards/validations

Request

{
  "associate": {
    "ssn": 555555555,
    "associateId": 12345
  }
}

Response

HTTP/1.1 200 OK