Purchase Reward Store Offer

Buys an offer from a reward store when a customer wants to exchange their available points for an offer displayed on a reward store page - often for immediate use.

There are really two operations that constitute the purchase of a reward store offer: one to spend, or remove, the points; and one to actually issue the offer to the customer. The endpoint featured in this task performs a single purchase transaction that executes these two operations. Doing so, ensures that customer data has been safeguarded, not left in an inconsistent state.

Sequence Diagram

See the overall flow for this task below.

CUSTOMER CUSTOMER CLIENT MIDDLEWARE CLIENT MIDDLEWARE SESSIONM SESSIONM PURCHASE REWARD STORE OFFER Decide to buy reward store offer Purchase reward store offer Return success message Display offer

API Endpoints & Constraints

POST /api/2.0/offers/rewardstores/purchase_offer

  • The call to purchase the reward store offer passes a request object that must contain the GUID for a point account. Without a string specified in the point_account_ids array, a reward store cannot be created. If this ID is not known, use the "GetAllBalances" endpoint in the UserPoints API to discover the customer's existing point accounts.