Offer State

Update a Collector’s opt-in status for a given AIR MILES offer from within your mobile app or website.

The purpose of this documentation is to provide a guide on how to integrate with the AIR MILES Offer State API. As part of this documentation, we also include information on RESTful HTTPS requests/responses, error codes, integration environments, and support contact information.

Target audience

This material is intended to be used by a Partner wishing to integrate with the AIR MILES Offer State API.

What is “Offer State”

Collectors can either load (i.e., opt-in to) offers through the AIR MILES mobile app/website (www.airmiles.ca), OR YOUR mobile app/website.

The Offer State API enables you to retrieve the Collector’s opt-in status for offers displayed within your mobile app or website, as well as update the opt-in status for an individual offer.

Important

The most important parameter in this API call is the offerId. It must match an existing offerId in our system to successfully retrieve or update the opt-in status. This ensures everything stays synchronized between our system and yours.

Service level objective

Please contact our Partner Support team for details on our Service Level Agreement (SLA).

Email Partner Support

Did you know

Our “Transaction Day” for real-time Issuance runs from 12:00AM to 11:59PM EST daily.

Integration environments

There are two sets of environments used by partners to integrate with the AIR MILES API library. These environments are configured similarly for consistent production-level quality, whether the partner has deployed to production or is still performing non-production testing.

Environment	Domain	Description
Test	https://uat.airmilesapis.ca	Contains production quality code and test data used for developing and testing 3rd party integrations.
Production	https://airmilesapis.ca	Contains production code and live user data for real-world 3rd party integrations.

Tip

ALL integration environments must be accessed via HTTPS only.

Your AMRP project team

In preparation for launch, an AIR MILES team is pulled together to assist Partners with integration and setup. This team will provide the following services:

Consulting Partners on the best technical solution to support AIR MILES Issuance based on system compatibility.
Providing guidance for assessing Partner requirements, data exchange methods, and reconciliation.
As well as overseeing a broad range of activities to meet the requirements of launch, including:
- Planning
- Communications
- Delivery
- Execution
- Monitoring

Commonly used acronyms

Name	Definition
L1	LoyaltyOne: Is the name of the parent organization that operates the AMRP.
AMRP	AIR MILES Rewards Program: The loyalty program itself consisting both AIR MILES issuance an redemption processes.
AMRM	AIR MILES Rewards Miles: The loyalty program currency that Collectors earn and redeem for travel, merchandise and cash rewards.
RTC	Real-Time Checkout: An AIR MILES API platform specifically tailored for “Real-Time Issuance” & redemption of AIR MILES “Reward Miles”.
M2M	Machine-to-Machine: Refers to direct communication between devices using any communications channel, including wired and wireless. This includes CLIs, daemons, or services running on your back-end that self-authenticates and/or authorizes an application without collector interaction.
POS	Point-of-Sale: Refers to the software/hardware component that handles transactional messages, as well as processing AIR MILES issuances and reversals (return transactions).