Loyalty Earn API
Access points earned from traveler bookings plus other key information
Manage your loyalty program
Use this data to provide an up-to-date view of both pending and awarded points.
| Field name | Definition | Example |
|---|---|---|
itinerary_id | The itinerary number or point of sale order reference number. | 72622069245694 |
transaction_type | The type of transaction recorded. | Possible values: Purchase Award Modification Cancel |
booking_date* | The date a booking was initially made, it is represented in ISO8601 Date format (YYYY-MM-DD).* | 2023-02-05 |
transaction_date* | The date a booking was last updated (modified). This is the same as the book date if the booking is never updated. The date is represented in ISO8601 Date format (YYYY-MM-DD). | 2023-02-05 |
transaction_datetime* | The date and time a booking was last updated (modified). These are the same as the book date and time if the booking is never updated, it is represented in ISO8601 date time format. | 2023-10-21T00:00:00.000-08:00 |
begin_use_date* | The date the travel begins: departure date, check-in date, pick-up date, etc. represented in ISO8601 Date format (YYYY-MM-DD). | 2023-02-05 |
end_use_date* | The date the travel ends: arrival date, check-out date, drop-off date, etc. represented in ISO8601 Date format (YYYY-MM-DD). | 2023-02-05 |
id (booking_item) | Booking item identification element (grouped under the booking_item object). | 1329922272 |
product_line | Business type of booking. | Possible values: Air Car Cruise Destination services Insurance Lodging Package Unknown |
package_indicator | Whether the booking is part of a package. | Possible values: Part of package Standalone Unknown |
currency_code | Currency code in which the booking was paid, as per the standard IBAN currency code format | USD |
gross_booking_value | Total booking amount including taxes and fees. | 694.8941 |
base_price | The amount charged to the customer before taxes, fees, and adjustments, forming the basis for awarded points. | 154.7863 |
award_date* | Date at which points will be earned represented in ISO8601 Date format (YYYY-MM-DD). | 2023-03-14 |
point_definition | Definition of the points applied as related to the campaigns or base points. | Partner_2X_promo |
pending_points | Number of points pending award | Broken down as: total: −100.11 base: −90.01 bonus: −10.1 |
awarded_points | Number of points awarded. | Broken down as: total: 100.11 base: 90.01 bonus: 10.1 |
program_name | Name of the loyalty program. | Rewards |
loyalty_tier | Tier of the program the member is in. This can be used to help determine bonus points, for example. | Standard |
last_name** | Last name of the loyalty program member. | Doe |
id (member) | Membership identification element (grouped under the member object). | 456178230 |
*Date fields are in Pacific Standard Time (PST), allowing for daylight savings.
**Personally Identifiable Information (PII) data. Please be sure to handle this correctly per your company’s guidelines. Please include only when absolutely necessary.
API details
Explore the endpoint definitions on this page, then use an API testing software to get an understanding of how the examples and schema definitions compare to the actual output.