Report whether a coupon code worked
report_coupon_resultCall this the turn the shopper says a code worked or failed. Records whether a coupon code or no-code deal tried at checkout worked (merchant and code for codes, including a code found outside McClipFace, with merchant as the store's domain; offer_id for no-code deals). Not a lookup. Stores no personal or cart data. Optional and off by default (Private mode, which lasts until the shopper changes it). Report only a confirmed result (the shopper says a code worked or was rejected, or a no-code deal did or didn't apply, or you saw it at checkout), never because a code was found, shown or copied. A result you saw counts only if you tried the code with checkout tools the shopper authorized, never an untested or unfinished one. One call per distinct code tested; a success counts even if another code saved more. Consent: report only in Community mode. After the first answer is shown (never before or instead of a search, or mid-try), ask once: "Want to turn on Community mode? It crowdsources deals for other shoppers like you. If you say Yes, we share the store, the code or deal, and whether it worked, never which option you pick, your cart or anything about you. (Yes / No)" Remember the answer if the shopper agrees to remembering it, and don't ask again unless the shopper brings it up ("turn on Community mode", "stop sharing"). Yes turns Community mode on for that conversation: report that result and later confirmed results, the shopper's and yours, until the shopper turns it off. No, or no answer, means report nothing and don't ask again in that conversation. It carries to later conversations only if the shopper agreed to remembering it and you noted the version and choice; do not ask again unless the shopper brings it up. A Community mode yes given to older wording that didn't say the store and code are shared doesn't count: stay in Private mode until the shopper says yes to the current question. No answer is no consent; never infer it from install, lookups or coupon tests. McClipFace can't verify consent, only your statement of it. Keep shopping either way; follow the host's tool approvals. Report once per offer and outcome; for a no-code deal, pass offer_id with outcome worked, didnt_work or not_found. Send only the store, the code or offer_id, the outcome, and optionally reason; never amounts, cart, totals or user data. Commission disclosure for the links the lookup tools return: Offers with tracked=true use affiliate links: a purchase through one may earn a commission at no extra cost. Say so once per chat, before you first share or open one: "This is an affiliate link and may earn a commission at no extra cost to you." Codes are ranked on the code itself. Results come only from affiliate programs McClipFace has joined, its licensed coupon data partner, stores that share their codes with McClipFace directly and codes shoppers reported working at checkout. Commission never affects which offers are returned or how they are ranked. It never puts a pricier option first.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"outcome": "<outcome>"
},
"name": "report_coupon_result"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | The code tried. Required for a code report; for a no-code deal omit it and pass offer_id. | |
| reason | No | Optional short note (at most 200 characters), e.g. why a deal didn't apply. Never cart, price, total or personal data. | |
| outcome | Yes | Codes: worked (checkout accepted it and the total went down), rejected or failed (the store refused it), link_broken (the offer link ended on an error page or never reached the store; never counts against the code). No-code deals: worked, didnt_work (didn't apply at checkout) or not_found (not on the store page or account). A code find_coupons didn't list: merchant and code with worked or rejected and no offer_id (kept for review; once reported working it is offered to other shoppers, for a store we don't list with merchant as its domain). store_not_covered: merchant only, when find_coupons found no match. Every outcome is sent only in Community mode; Private mode, or no mode chosen yet, sends nothing. | |
| merchant | No | Store name as used with find_coupons, e.g. "Tommy John". Required with code; optional with offer_id. | |
| offer_id | No | Offer id from find_coupons. Required for no-code deal reports; for codes, used instead of merchant and code when set. | |
| eligibility | No | eligible: the store said the code itself is invalid or expired; ineligible: the cart, product or account didn't qualify, or it can't stack with another promotion (say so in reason); unknown: can't tell. Only an eligible rejection counts against a code. Don't report inconclusive tests or a code accepted that saved nothing extra. | unknown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| offer_id | No | ||
| disclosure | Yes |