Register your checkout for Spin the Wheel rewards

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
enum
required
Allowed:
string
required
length ≤ 255

Your checkout's host. An app connection must send its connected store's host.

string
required
length between 3 and 3

Your checkout's currency. Must match the business's currency, or rewards can't be saved for it.

string | null
enum

The platform whose product ids your checkout uses, when you sync products with store ids.

Allowed:
reward_types
array of strings, unique
required
length ≤ 4

The reward types your checkout can honour. Only these are offered on the wheel. An empty list keeps the registration but offers nothing.

constraints
object
Responses

401

Unauthenticated

403

The key is not granted wheel:rewards, or an app connection sent another store's host

404

Spin the Wheel is not switched on for this account

422

Invalid capabilities, or platform names another app's platform (platform_mismatch)

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json