Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Cart Promotions for a Customer

This API is used to retrieve the cart promotions tagged to a particular customer based on the user ID. This returns cart promotions issued to the customer or POS promotions which are tagged to the customer's tier or supplementary programs.

get/api_gateway/v1/promotions/customer/109943742?includeRedemptions=true&includeSupplementaryPromotions=true

Query parameters

includeRedemptionsboolean

includeRedemptions=true includes the restrictions applied to the promotion including max limit and remaining redemptions

includeSupplementaryPromotionsboolean

includeSupplementaryPromotions=true includes the POS promotions tagged to the customer's tier or supplementary program

Response

200

OR
OR
OR
OR

Example response

{
  "data": [
    {
      "promotionId": "6460c3e8bd84737237d53ae6",
      "promotionName": "25¢ off per gallon for Gold Members",
      "validTill": 1704067199999,
      "customerId": 100458,
      "earnedType": "TIER",
      "earnedStatus": "UNLOCKED",
      "promotionStatus": "ACTIVE",
      "supplementaryCriteria": {
        "loyaltyProgramId": 469,
        "programType": "TIER",
        "partnerProgramId": 1207
      },
      "applicationMode": "DISCOUNT",
      "customFieldValues": {
        "t&c": "5¢ off per gallon for Premium Members SF for all fuel ups",
        "Test_Cap": "5¢ off per gallon for Premium Members SF for all fuel ups",
        "Field": "5¢ off per gallon for Premium Members SF for all fuel ups",
        "image_url": "5¢ off per gallon for Premium Members SF for all fuel ups",
        "partner 1 liability value": "1"
      },
      "restrictions": {
        "Cart": [
          {
            "kpi": "REDEMPTION",
            "maxLimit": "99999.000000",
            "remainingRedemption": "99999.000000"
          }
        ],
        "Customer": [
          {
            "kpi": "REDEMPTION",
            "maxLimit": "99999.000000",
            "remainingRedemption": "99981.000000"
          }
        ]
      },
      "eventTime": 1684002600000
    }
  ]
}