Report whether a coupon code worked
report_coupon_resultRecords whether a McClipFace (formerly Clippy) coupon code worked at checkout (merchant, code, worked or rejected). Stores no personal or cart data. Call it only when the shopper has turned on Community mode, after the user has tried the code. Report once per code per checkout, after the final attempt: every result, worked or failed (consent is presumed). In Private mode, or before the shopper picks a mode, do not call it. Send only the store, the code and the outcome; never cart, totals or user data.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | Yes | The code that was tried. | |
| outcome | Yes | worked: checkout accepted it and the total went down. rejected (or failed): the store refused it. | |
| merchant | Yes | Store name as used with find_coupons, e.g. "Tommy John". | |
| offer_id | No | Optional: the offer id from find_coupons; used instead of merchant and code. | |
| eligibility | No | eligible only when the code's known terms were met; ineligible when they were not (an ineligible rejection does not count against the code). | unknown |
| saved_amount | No | Optional, worked only: amount saved. Only whether it is above 0 is stored, never the amount. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| offer_id | No |