Examine

Examine rewards

Changed on

Evaluates rewards assigned to a customer's active Loyalty v2 program memberships. Applies temporary customer and member metadata overrides without updating stored data. Returns reward availability by card, including points costs and applicable unavailability reasons. Omits a reward when it is inactive, out of stock, has no matching cost, or the member has no card for that cost.

This endpoint can examine rewards for all loyalty programs the customer belongs to by using customer_identification with customer_id or customer_source_id. To examine rewards only for one program, use member_id in customer_identification, as member_id is loyalty program-specific. A customer who exists but has no active membership returns 200 with an empty memberships array.

post/v2/loyalties/examine/rewards

Request

  • Base URL
    https://api.voucherify.io
  • URL
    https://api.voucherify.io/v2/loyalties/examine/rewards
  • Auth
    • API key in header X-App-Id and API key in header X-App-Token
    • or HTTP bearer

Request body

Response

Rewards examination result. An empty memberships array means the customer has no active membership. An empty cards array means no assigned reward resolved onto a card.

object'rewards_examine_result' required

Object type marker. Always rewards_examine_result.

Changes

  • v2d050da3a1603Revision changes
    • breaking

      the //// response's property type changed from no type to object for status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      removed subschema #2 from the //// response property oneOf list for the response status

    • info

      added the required property ///// to the response with the status

  • v2c56e6909b766Revision changes
    • breaking

      the response property /// became optional for the status

    • breaking

      the response property /// became optional for the status

    • breaking

      added subschema #2 to the //// response property oneOf list for the response status

    • breaking

      the //// response's property type changed from object to no type for status

    • breaking

      removed the required property ///// from the response with the status