This guide walks you through integrating with the Rye API, from setting up your account to submitting your first order to Shopify.
The example in this guide uses Shopify, but the same process can be used to send orders to Amazon, non‑Shopify stores, and other merchants. You only need to replace the product URL with one from the merchant you want to order from.
POST
request to /api/v1/checkout-intents
with the product URL and buyer identity.
awaiting_confirmation
/api/v1/checkout-intents/{id}
enpdoint with a GET
request until it reaches the awaiting_confirmation
state. Use the value of the id
field returned in step 3.
For additional context:
- All processing is asynchronous. Always poll the
GET
endpoint after each major step.- Once in a terminal state (
completed
orfailed
), the intent is complete.- Use
failureReason
to display helpful error messages to users.
GET /api/v1/checkout-intents/{id}
response payload.
POST /api/v1/checkout-intents/{id}/confirm
. Replace the stripeToken
value with the token generated in step 6.
GET
endpoint again until you reach one of the terminal states:
completed
: Order was placed successfully.failed
: Something went wrong (e.g., out of stock, expired).