Promo Abuse Integration

Testing Your Integration

After completing integration, you should test that you correctly handle our promo abuse recommendation responses.

Use your sandbox account to test:

  • Switch to your sandbox account from the account menu in the Ravelin dashboard.
  • Your sandbox secret API key can be accessed in the API Keys tab of the Developer section of the dashboard.
  • For more details on your API keys see Authentication.

We recommend testing the following scenarios:

ScenarioHow to testExpected result
ALLOWSend a request for a new customer with a code that has not been used in their network.ALLOW is returned and the discount is applied. A redemption is sent when the voucher is redeemed.
PREVENTCreate a rule in the Promo Abuse category targeting a test voucher code, then send a request with that code.PREVENT is returned. The discount is not applied, a message is shown and checkout continues at full price.
Network limitRedeem the same code from several customers on the same device until the threshold is reached, then request a recommendation for another customer on that device.PREVENT is returned once the threshold is reached.
ReferralRequest a recommendation for a REFERRAL code where the customer shares a device with the referrer.The referrer counts as one use towards the threshold.
Order linkingSend a request with an orderId, then send the Checkout request with the same orderId.The assessment is linked to the order in Ravelin dashboard.

View the assessment in the Ravelin dashboard

To ensure the request was handled correctly and investigate how we produced the recommendation, you can view the customer’s details in the Ravelin dashboard.

Ensure you’re logged into the Ravelin dashboard with your sandbox account.

  • Click Explore in the left hand menu and select the customer you sent a request for. The customer profile shows the Voucher Assessment recommendation and the rules that triggered. Customers who are new to Ravelin appear once you register a referral voucher for them or send a voucher redemption.
  • To view all voucher assessments, open Insights and select the Voucher Assessments view.
  • To view the requests you sent, open the Developer section and go to Request logs.

Feedback