Tells Oyster which reward types your checkout can honour. While the registration is live,
your checkout is where the business's wheel rewards are issued and redeemed, and they are no
longer redeemable at Oyster's checkout. Call it from your server with a key granted
wheel:rewards. A Shopify app or WooCommerce plugin connection may call it too, and then
registers as its own platform.
The registration is live while all of these hold:
- it was refreshed in the last 48 hours (refresh it daily),
- the key that registered it still exists and is granted
wheel:rewards, - an active webhook endpoint on the account subscribes to
wheel.reward_won.
When any stops holding, the wheel moves back to Oyster's checkout within a minute. A store
the Oyster Shopify app or WooCommerce plugin is connected to is the checkout ahead of a
registration.
Send platform when your store runs on Shopify or WooCommerce and you sync its products
with store ids; reward terms then carry those ids. Without it, terms carry Oyster product
ids and SKUs.
Each win is delivered as a wheel.reward_won event with redemption_authority: store.
Create the code in your checkout from that event, keyed on reward_id.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
401Unauthenticated
403The key is not granted wheel:rewards, or an app connection sent another store's host
404Spin the Wheel is not switched on for this account
422Invalid capabilities, or platform names another app's platform (platform_mismatch)