Skip to content

PurchaseRequirement

A purchase requirement object contains information on required or disqualifying purchases for an offer.

Property Type Description
requirementType PurchaseRequirementType The type of purchase requirement. See PurchaseRequirementType for possible values. The enumeration is represented as a string in the JSON.
purchaseTypes PurchaseType[] 5.3+

PurchaseRequirementType

The PurchaseRequirementType enumeration defines various requirements or limitations for purchases. The values are represented as string in the API reponse.

Value Description
MustPurchase Indicates that the purchase types are required in order for the offer to be rewarded.
MustNotPurchase Indicates that the corresponding purchase typs are exempt from the offer. Purchases of these types will not contribute to the minimum spend or to the reward amount.

PurchaseType

The PurchaseType enumeration defines various product types that are either required or exluded from an offer.

The values are represented as string in the API reponse.

Value Description
Subscription A recurring subscription, such as to an online streaming service or a utility.
Membership A membership to a club, warehoue store, organization, etc.
Fuel Gasoline, diesel, etc. Used for gas station offers to require or exclude the purchase of gas for offers.

Note that new values may be added in the future and clients should gracefully handle/ignore any unknown/new values.

Examples

When an offer does to count towards the purchase of fuel, for example at a gas station 

1
2
3
4
5
6
"purchaseRequirement" : {
    "requirementType" : "MustPurchase",
    "purchaseTypes" : [
        "Fuel"
    ]
}

When an offer requires the purchase of a membership, for example at a warehouse store 

1
2
3
4
5
6
"purchaseRequirement" : {
    "requirementType" : "MustPurchase",
    "purchaseTypes" : [
        "Membership"
    ]
}