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 Checkout Intents API

The Checkout Intents API from Rye — 6 operation(s) for checkout intents.

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

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

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

7 operations 6 paths 77 schemas 4 GET3 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 Checkout Intents 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 7

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

Checkout Intents 7
GET
/api/v1/checkout-intents
List checkout intents
ListCheckoutIntents 5 params → 200401404422
POST
/api/v1/checkout-intents
Create checkout intent
CreateCheckoutIntent body → 201401422500503
GET
/api/v1/checkout-intents/{id}
Retrieve checkout intent
GetCheckoutIntent 1 param → 200401404
GET
/api/v1/checkout-intents/{id}/order
Retrieve order
GetCheckoutIntentOrder 1 param → 200401404
POST
/api/v1/checkout-intents/{id}/confirm
Confirm checkout intent
ConfirmCheckoutIntent 1 param body → 200401404409500
GET
/api/v1/checkout-intents/{id}/shipments
List shipments for checkout intent
GetShipments 4 params → 200401404422
POST
/api/v1/checkout-intents/purchase
Purchase product
Purchase body → 201401422500503

Schemas 77

The contract defines 77 schemas that model the data the API accepts and returns. The most detailed are Buyer (10 properties), BaseCheckoutIntent (10 properties), CheckoutIntentPostParams (8 properties), OrderResponse (6 properties). Each schema is shown below with its type and property counts.

PaymentMethod
AwaitingConfirmationCheckoutIntent
WithStatus_BaseShipmentWithTracking.shipped_
RequiresActionCheckoutIntent
CheckoutIntentConfirmParams
object
1 property 1 required
ShipmentWithoutTrackingUnion
Shipments without tracking information
ShipmentsListResponse
object
2 properties 2 required
EventLocation
object
3 properties
DelayedShipment
PromoCode
string
Promo code string with validation constraints. - Must contain only letters, digits, underscores, or hyphens - Maximum length of 32 characters
DeliveryDate
object
1 property 1 required
CheckoutIntentPostParams
object
8 properties 3 required
StripeTokenPaymentMethod
object
2 properties 2 required
Cancellation
RetrievingOfferCheckoutIntent
RuntimeError
object
3 properties 2 required
OrderResponse
object
Represents a completed order. Orders are created after a checkout intent reaches the completed state.
6 properties 5 required
X402PaymentMethod
object
2 properties 2 required
InvalidCheckoutIntentStateError
object
4 properties 2 required
CanceledShipment
TrackingEvent
object
4 properties 4 required
NotFoundError
object
3 properties 2 required
WithStatus_BaseShipmentWithTracking.delayed_
CancellationDenialReasonCode
string
ShipmentUnion
CancellationDenialReason
object
2 properties 2 required
ShipmentWithTrackingUnion
Shipments that have tracking information (shipped, delayed, or delivered states)
AmazonUnavailableError
object
3 properties 2 required
X402NextAction
object
2 properties 2 required
DeliveryEstimate
object
Estimated range of dates that items will be delivered in. At least one of earliest or latest are guaranteed to be set. Interpretation: If both earliest and lat…
2 properties
ValidateError
object
5 properties 4 required
BaseCheckoutIntent
object
10 properties 5 required
PlacingOrderCheckoutIntent
VariantSelection
object
2 properties 2 required
Shipment
ShipmentTracking
object
4 properties 1 required
CheckoutIntent
OutForDeliveryShipment
Money
object
2 properties 2 required
FailedCheckoutIntent
FailureReason
object
2 properties 2 required
DeliveredShipment
NextAction
Buyer
object
10 properties 9 required
FieldErrors
object
OrderedShipment
Shipping
object
2 properties 1 required
CancellationReasonCode
string
AuthenticationError
object
3 properties 2 required
DrawdownPaymentMethod
object
1 property 1 required
WithStatus_BaseShipment.canceled_
CancellationReason
object
2 properties 1 required
RequestedCancellation
BaseShipmentWithTracking
CompletedCancellation
ShipmentStatus
string
ShippingOption
object
4 properties 2 required
CheckoutIntentState
string
TrackingEventTimestamp
object
2 properties 2 required
ShippingDetails
object
4 properties 4 required
CompletedCheckoutIntent
BasisTheoryPaymentMethod
object
2 properties 2 required
CheckoutIntentListResponse
object
2 properties 2 required
FailureReasonCode
string
Type derived from runtime array - always in sync
WithStatus_BaseShipmentWithTracking.delivered_
DeniedCancellation
ShippedShipment
WithStatus_BaseShipment.ordered_
CommissionPotential
object
The commission a developer would earn if this offer is placed.
2 properties 2 required
Cost
object
6 properties 2 required
OfferRetrievalEffort
string
Controls how much effort the system should spend retrieving an offer. - 'max': Full effort including AI agent fallback (slower, higher success rate) - 'low': F…
Offer
object
4 properties 2 required
BaseCancellation
object
5 properties 5 required
CheckoutIntentPurchaseParams
Post body for the purchase endpoint - combines create + confirm in one step. Triggers the durable workflow that handles offer retrieval and order placement.
WithStatus_BaseShipmentWithTracking.out_for_delivery_
BaseShipment
object
5 properties 5 required
CheckoutConstraints
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rye-checkout-intents-api-openapi.yml Raw ↑

Other APIs Rye publishes across the network.

Rye Betas API
Rye Billing API
Rye Brands API
Rye Commissions API
Rye Events API
Rye Merchant Connectors API
Rye Orders 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 Checkout Intents 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.