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

Rye Orders API

The Orders API from Rye — 3 operation(s) for orders.

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

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

This API exposes 3 operations across 3 paths, and defines 20 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.

3 operations 3 paths 20 schemas 2 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
License
UNLICENSED
Terms of Service
Resource Areas
1

Authentication & Security 1

Rye Orders 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 3

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

Orders 3
GET
/api/v1/orders
List orders
ListOrders 3 params → 200401422
GET
/api/v1/orders/{id}
Get order
GetOrder 1 param → 200401404
POST
/api/v1/orders/{id}/cancel
Cancel order
CancelOrder 1 param body → 200401404409422

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are OrderResponse (6 properties), BaseCancellation (5 properties), ValidateError (5 properties), CancellationNotApplicableError (4 properties). Each schema is shown below with its type and property counts.

CancellationDenialReason
object
2 properties 2 required
FieldErrors
object
ValidateError
object
5 properties 4 required
CancellationReasonCode
string
OrderCancelParams
object
Body for POST /orders/{id}/cancel. The order id comes from the URL, so the caller only supplies the cancellation reason (code + optional note).
1 property 1 required
AuthenticationError
object
3 properties 2 required
DeniedCancellation
CancellationNotApplicableError
object
The order cannot be programmatically cancelled — the store has no active integration, or the store's cancellation policy disallows it (disabled, outside the al…
4 properties 3 required
CancellationReason
object
2 properties 1 required
RequestedCancellation
EnumValues_typeofCancellationRejectionCode_
string
The value-union of a {@link stringEnum} — e.g. 'red' | 'blue'.
CancellationNotApplicableCode
Why a programmatic cancellation was rejected. storenotintegrated is our own pre-policy gate (not a Shopify store, or no active integration); the remaining code…
Cancellation
OrderResponse
object
Represents a completed order. Orders are created after a checkout intent reaches the completed state.
6 properties 5 required
CompletedCancellation
NotFoundError
object
3 properties 2 required
BaseCancellation
object
5 properties 5 required
OrdersListResponse
object
2 properties 2 required
CancellationRejectionCode
Reason code for why automatic cancellation is not available/allowed for an order. Naming convention — , two namespaces: - cancellation — about the cancellation…
CancellationDenialReasonCode
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rye-orders-api-openapi.yml Raw ↑

Other APIs Rye publishes across the network.

Rye Betas API
Rye Billing API
Rye Brands API
Rye Checkout Intents API
Rye Commissions API
Rye Events API
Rye Merchant Connectors API
Rye Payment Gateways API
Rye Products API
Rye Returns API
Rye Shipments API
Rye Test Helpers API
Where this information came from

This is an independent, third-party profile of Rye Orders 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.