Manage loyalty programs (v1.0)

Download OpenAPI specification:Download

License: Open API Specification - OAS Terms of Service

Use this API to manage loyalty coupons and reward program coupon definitions for your business.

These coupons can later be used via Associate App to offer discounts to customers enrolled in the loyalty program. See the guide.

Create loyalty coupon

Use this method to create coupon codes on the fly to be used with a loyalty program.

Important: Loyalty coupons are only valid for 15 minutes.

The type of coupons available for this functionality are of type cart fixed and cart percentage discounts.

Authorizations:

newStoreAccessToken

Request Body schema: application/json

a loyalty coupon

Array of objects

Array

name required	string The name of the promotion.
discount required	number The value of the discount, either as fixed amount or percentage (between 0 and 100).
type required	string Enum: "Fixed" "Percentage" The type of discount. Can be 'Fixed' or 'Percentage'.
level required	string Value: "Cart" The level at which the promotion applied. So far just 'Cart' is supported.
	Array of objects
voucherId required	string The unique id on the other system.

Responses

Request samples

Payload

Content type

application/json

{"vouchers": [{"name": "fixed amount discount - 2000 points",
"discount": 50,
"type": "Fixed",
"level": "Cart",
"currencies": [{"code": "USD",
"minimumCartValue": 50
}
],
"voucherId": "37e6476f-a124-495d-acd7-3ba4e3b0a739"
}
]
}

Response samples

Content type

application/json

{"codes": ["CODE1",
"CODE2",
"CODE3"
],
"warnings": [{"code": "voucher_mismatch",
"ref": "voucher-id-1",
"kind": "voucher",
"message": "there's a mismatch between the voucher ID and the name of the voucher"
}
]
}