API delivery for Loyalty Earn
With Loyalty Earn, you can reconcile your customers’ loyalty rewards with your program. You can also use the data to provide an up-to-date view of pending and awarded points, analyze program trends, and create reports for your stakeholders.
Delivery options
Our Loyalty Earn offering allows you to retrieve data via a pull mechanism, which provides detailed itinerary data to support:
- Data analysis
- Award points to customers
- Help desk investigations
This service consists of two HTTP GET endpoints that allow you to:
- See when data was last updated. Loyalty points are updated on a daily basis.
- Create a list of pending or rewarded loyalty currency in a specified time range using the
transaction_date_start,transaction_date_end,and membership_idoritinerary_idvariables
For details on the authentication process, see API setup.
Available fields
The tables below list the fields, including any nested objects, available through our push and pull delivery methods.
| 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 |
transaction_date* | The date a booking was last modified. This is the same as the book date if the booking is never updated. Represented in ISO 8601 date format (YYYY-MM-DD). | 2023-02-05 |
transaction_datetime* | The date and time a booking was last modified. If no updates have been made, this value is the same as the book_date. | 2023-10-21T00:00:00.000Z |
booking_item | Object representing individual booking elements. See the booking_item table for nested items. | — |
package_indicator | Whether the booking item is part of a package (such as flight + hotel). | Possible values: Part of package Standalone Unknown |
currency_code | Currency in which the booking was paid, represented in standard International Bank Account Number (IBAN) currency code format. | USD |
gross_booking_value | The gross booking value (GBV), or total booking amount including taxes and fees, in the currency used to pay. | 694.89 |
base_price | The amount charged to the customer before taxes, fees, and adjustments, forming the basis for awarded points. Shown in the currency used to pay. | 154.78 |
award_date* | Date at which points will be awarded, represented in ISO 8601 date format (YYYY-MM-DD). | 2023-03-14 |
point_definition | Indicator of a campaign or promotion that changes your program’s base earning model. | Partner_2X_promo |
pending_points | Number of points earned but not yet awarded. | Broken down as: total: –100.11 base: –90.01 bonus: –10.1 |
awarded_points | Number of points awarded for the transaction. | Broken down as: total: 100.11 base: 90.01 bonus: 10.1 |
program_name | Name of the loyalty program. | Rewards |
member | Object representing customer information. See the member table for nested items. |
Notes for all fields
* Date fields are in Pacific Standard Time (PST), allowing for daylight savings.
** Personally Identifiable Information (PII) data. Be sure to handle this correctly per your company’s guidelines and 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.