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 Shipments API

The Shipments API from Rye — 2 operation(s) for shipments.

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

Tagged areas include Shipments. 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 30 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 30 schemas 2 GET

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 Shipments 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 — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Shipments 2
GET
/api/v1/shipments
List shipments
ListShipments 5 params → 200401404422
GET
/api/v1/shipments/{id}
Retrieve shipment by id
GetShipment 1 param → 200401404

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are ValidateError (5 properties), BaseShipment (5 properties), ShipmentTracking (4 properties), TrackingEvent (4 properties). Each schema is shown below with its type and property counts.

DeliveredShipment
ShipmentUnion
WithStatus_BaseShipmentWithTracking.shipped_
ShipmentWithTrackingUnion
Shipments that have tracking information (shipped, delayed, or delivered states)
ShipmentWithoutTrackingUnion
Shipments without tracking information
ShipmentsListResponse
object
2 properties 2 required
FieldErrors
object
OrderedShipment
EventLocation
object
3 properties
DelayedShipment
ValidateError
object
5 properties 4 required
WithStatus_BaseShipmentWithTracking.delivered_
AuthenticationError
object
3 properties 2 required
WithStatus_BaseShipment.canceled_
ShippedShipment
DeliveryDate
object
1 property 1 required
Shipment
BaseShipmentWithTracking
CanceledShipment
WithStatus_BaseShipment.ordered_
ShipmentTracking
object
4 properties 1 required
TrackingEvent
object
4 properties 4 required
ShipmentStatus
string
NotFoundError
object
3 properties 2 required
WithStatus_BaseShipmentWithTracking.delayed_
OutForDeliveryShipment
TrackingEventTimestamp
object
2 properties 2 required
WithStatus_BaseShipmentWithTracking.out_for_delivery_
BaseShipment
object
5 properties 5 required
ShippingDetails
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rye-shipments-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 Orders API
Rye Payment Gateways API
Rye Products API
Rye Returns API
Rye Test Helpers API
Where this information came from

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