Rye

Rye Test Helpers API

The Test Helpers API from Rye — 6 operation(s) for test helpers.

GitHub OpenAPI

Operations 6

POST /api/v1/test-helpers/checkout-intents/{checkoutIntentId}/shipments/advance Advance simulated shipment #
POST /api/v1/test-helpers/returns Create simulated return #
POST /api/v1/test-helpers/returns/{returnId}/approve Approve simulated return #
POST /api/v1/test-helpers/returns/{returnId}/deny Deny simulated return #
POST /api/v1/test-helpers/returns/{returnId}/refund Refund simulated return #
POST /api/v1/test-helpers/returns/{returnId}/fail Fail simulated return #

Documentation

📖
Documentation
https://rye.com/docs/api-v2/introduction
📖
APIReference
https://rye.com/docs/api-v2-experimental/api-reference
📖
GettingStarted
https://rye.com/docs/api-v2/example-flows/simple-checkout

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/rye/refs/heads/main/openapi/rye-test-helpers-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/rye-test-helpers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

rye-test-helpers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Universal Checkout Test Helpers API
  version: 1.0.5
  description: 'Turn any product URL into a completed checkout. Instantly retrieve price, tax, and shipping for any product, and let users buy without ever leaving your native AI experience.


    View the Rye API docs.'
  termsOfService: https://rye.com/terms-of-service
  license:
    name: UNLICENSED
  contact:
    name: Rye
    email: dev@rye.com
    url: https://docs.rye.com
servers:
- url: https://staging.api.rye.com
tags:


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rye/refs/heads/main/openapi/rye-test-helpers-api-openapi.yml