Sign in
Reference

API reference

The Theyutes REST API is JSON in, JSON out. Versioned at /api/v1. Amounts in kobo. Cursor pagination. Bearer-token auth.

Base URL

https://theyutes.com/api/v1

Everything below lives at a path beneath that root. Every endpoint expects (and returns) application/json. Every write endpoint accepts an optional Idempotency-Key header when it makes sense — see the per-endpoint page for specifics.

OpenAPI spec

The full OpenAPI 3.1 spec is auto-generated from the same registry that drives this page. Import it directly into Postman, Insomnia, or any code generator:

https://theyutes.com/api/v1/openapi.json

With the OpenAPI URL you can generate a typed client in any language Stainless, Speakeasy, Fern, or openapi-generator-cli support — TypeScript, Python, Ruby, Go, Java, Rust, and more.

Orders

GET
/api/v1/orders
List orders
GET
/api/v1/orders/{id}
Get a single order
PATCH
/api/v1/orders/{id}
Advance order status

Products

GET
/api/v1/products
List products

Customers

GET
/api/v1/customers
List customers

Refunds

GET
/api/v1/refunds
List refunds
POST
/api/v1/refunds
Issue a refund

Discounts

GET
/api/v1/discounts
List discount codes

Logistics

POST
/api/v1/logistics/quote
Quote a shipment
POST
/api/v1/logistics/dispatch
Dispatch a shipment (with auto-failover)
GET
/api/v1/logistics/shipments/{id}
Get a shipment
POST
/api/v1/logistics/shipments/{id}/cancel
Cancel a shipment
GET
/api/v1/logistics/shipments/{id}/track
Live shipment tracking
POST
/api/v1/logistics/predictive-schedulebeta
Schedule a just-in-time rider
GET
/api/v1/logistics/surge
Zone surge multiplier
GET
/api/v1/logistics/zones
Active delivery zones

Inventory

GET
/api/v1/inventory
List inventory