Docs

Build agentic commerce with Rye.

These local docs cover the public surface needed for the landing site. The production API reference can still live behind the developer console or a dedicated docs service.

Create an order

Send Rye the product URL, buyer details, shipping address, and payment token. Rye returns order state and webhook events as checkout progresses.

Resolve product data

Use product URLs to retrieve title, image, price, availability, variants, shipping options, and checkout requirements before purchase.

Track fulfillment

Subscribe to order, shipment, cancellation, and refund events so your app can keep buyers informed after checkout.

Example request

POST /orders
{
  "productUrl": "https://merchant.example/products/sku",
  "quantity": 1,
  "shippingAddress": { "...": "..." },
  "paymentToken": "tok_..."
}