Examine Qualification

The method can be used for sending a request to display all campaigns qualified to the given customer and context (e.g., order). A checking logic will be run only among campaigns and will ignore standalone vouchers. As a recommended subsequent step after selecting qualified campaign is to publish voucher code from that campaign. The API method for publishing will return a unique code which will belong to a given customer.

As a sample use case, you can imagine a requirement of displaying below cart the coupons (grouped in campaigns) eligible to a customer. The customer should get assigned to the particular voucher from the campaign and then might redeem that code when he places an order.

Read about Qualification API limits before you start.

Returns

This operation returns the list of valid and active campaigns based on the qualification of given context (e.g., customer profile, redemptions metadata, order).

Read about Qualification API limits before you start.

Language
Response
Click Try It! to start a request and see the response here!