How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Rye

Rye Returns API

The Returns API from Rye — 2 operation(s) for returns.

Documentation Provider Profile APIs.io OpenAPI GitHub

Rye Returns API is one of 13 APIs that Rye publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Returns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 1.0.5.

Requests are made against a single base URL, https://staging.api.rye.com.

2 operations 2 paths 19 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.5
Base URL
https://api.rye.com/api/v1/
Authentication
API Key
Contact
Rye
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Rye Returns API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (bearerAuth).

  • bearerAuth — Rye API key

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Returns 2
POST
/api/v1/returns
Create return
RequestReturn body → 201401422500
GET
/api/v1/returns/{returnId}
Get return
GetReturn 1 param → 200401404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are ReturnResponse (12 properties), ReturnTimeline (6 properties), ValidateError (5 properties), NotFoundError (3 properties). Each schema is shown below with its type and property counts.

ReturnFailureCode
string
Discriminator for the failure sub-object on a failed Return: - drawdowncreditfailed — the merchant refund succeeded but Rye could not credit it back; the refun…
ReturnDeclineReason
string
Why a merchant declined a return: - finalsale — the item was sold as final sale and is not returnable. - returnperiodended — the return window had already clos…
ReturnPostParams
object
Request body for POST /api/v1/returns. Whole-order returns only — server enumerates the order's line items at create time.
2 properties 2 required
FieldErrors
object
ValidateError
object
5 properties 4 required
ShippingLabel
object
A prepaid return shipping label the shopper uses to send items back.
1 property 1 required
AuthenticationError
object
3 properties 2 required
RuntimeError
object
3 properties 2 required
ReturnDenialResponse
object
Why a return was declined by the merchant.
2 properties 1 required
RefundResponse
object
A single refund issued against a refunded Return.
3 properties 3 required
ReturnResponse
object
A single Return record. The state discriminator tells you which of denial, failure, and refunds is populated; nextAction is set once the Return is approved (se…
12 properties 8 required
NotFoundError
object
3 properties 2 required
ReturnFailureResponse
object
Details of a failed return.
2 properties 2 required
NextActionType
string
Discriminator for {@link NextActionResponse }: shipitemstomerchant (the shopper must return the items with the provided label) or noactionrequired (a keep-the-…
ReturnState
string
Lifecycle state of a Return: - requested — submitted to the merchant, awaiting approval. - requiresaction — approved; the shopper must ship the items back. - p…
Money
object
2 properties 2 required
ReturnTimeline
object
Per-transition timestamps for a Return. requestedAt is always set; the rest fill in as the Return advances and reflect the path it actually took (a denied Retu…
6 properties 1 required
NextActionResponse
object
What the shopper has to do next to complete the return. Present once the Return is approved. type is the discriminator: shipitemstomerchant carries the matchin…
2 properties 1 required
ReturnReason
string
Reason a shopper is returning an order, supplied on the create-return call: defective (arrived damaged or faulty), wrongitem (not what was ordered), unwanted (…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rye-returns-api-openapi.yml Raw ↑

Other APIs Rye publishes across the network.

Rye Betas API
AE Profile APIs.io
Rye Billing API
AE Profile APIs.io
Rye Brands API
AE Profile APIs.io
Rye Checkout Intents API
AE Profile APIs.io
Rye Commissions API
AE Profile APIs.io
Rye Events API
AE Profile APIs.io
Rye Merchant Connectors API
AE Profile APIs.io
Rye Orders API
AE Profile APIs.io
Rye Payment Gateways API
AE Profile APIs.io
Rye Products API
AE Profile APIs.io
Rye Shipments API
AE Profile APIs.io
Rye Test Helpers API
AE Profile APIs.io
#Returns
← Back to R APIs
API Details
ID
rye:rye-returns-api
Base URL
https://api.rye.com/api/v1/
Docs
https://rye.com/docs/api-v2/introduction
Provider
Rye
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=rye-returns-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/rye-returns-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Rye Returns API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.