DEVELOPERS

API-first by design.

Everything in Carriyo is accessible through our REST API. Create shipments, manage orders, configure carriers, track deliveries, and process returns - all programmatically with comprehensive documentation and SDKs.

View API Reference

API OVERVIEW

One API. Complete post-checkout control.

RESTful Architecture

Clean, predictable resource-based URLs. Standard HTTP methods, status codes, and JSON request/response bodies.

OAuth 2.0 Authentication

Secure token-based auth with scoped permissions. Support for machine-to-machine and user-delegated flows.

Comprehensive Coverage

Every feature available in the dashboard is accessible via API. Orders, shipments, carriers, tracking, returns, and analytics.

Pagination & Filtering

Efficient data retrieval with cursor-based pagination, field filtering, and advanced query parameters for large datasets.

Rate Limiting

Generous rate limits with clear headers. Burst allowances for peak operations and dedicated limits for enterprise accounts.

Sandbox Environment

Full-featured sandbox for development and testing. Mirror production behavior without affecting live data or carrier accounts.

API RESOURCES

Core API endpoints.

Carriyo's API is organized around the key resources of the post-checkout lifecycle.

OrdersShipmentsCarriersTrackingReturnsWebhooksLabelsAnalyticsInventoryNotifications

GETTING STARTED

Start building in minutes.

01

Get API Credentials

Sign up for a Carriyo account and generate your API keys from the developer settings.

02

Explore the Sandbox

Use the sandbox environment to test your integration without affecting production data.

03

Go Live

Switch to production credentials when ready. Same API, same endpoints, live carrier connections.

Ready to integrate?