Carriyo Plug & Play specification
Updated May 26, 20262 min read
The Carriyo Plug & Play API specification defines a fixed set of RESTful endpoints that you implement on your side. Once your endpoints are live, Carriyo's connector calls them to create shipments, fetch labels, schedule collections, cancel shipments, and pull tracking updates. You own the implementation; Carriyo owns the connector.
Live API reference
Browse the spec
Operation-by-operation reference with request and response schemas. The authoritative source.
Open API reference
OpenAPI 3.0
Download the spec
The raw OpenAPI YAML, feed it into your codegen, mock server, or contract-testing tools.
Download plugnplay.yaml
What you'll implement
The spec defines six operations:
| Operation | Direction | What it does |
|---|---|---|
| Create Shipment | Carriyo → You | Book a shipment in your system. You return tracking number, AWB, and (where applicable) a label. |
| Fetch Label | Carriyo → You | Return the label artifact for a previously created shipment, on demand. |
| Schedule Collection | Carriyo → You | Request a pickup for one or more shipments. |
| Cancel Shipment | Carriyo → You | Cancel a previously booked shipment before it ships. |
| Shipment Tracking | Carriyo → You | Pull the latest status of a shipment when real-time updates aren't available. |
| Status Update Webhook | You → Carriyo | Push real-time status updates as the shipment moves through your network. |
The first five operations are inbound: Carriyo calls your endpoints. The webhook is the one operation you initiate: when a shipment's status changes, push the update to Carriyo immediately.
What the spec covers
For each operation, the OpenAPI document defines:
- URL structure: the endpoint path Carriyo will call.
- Request payload: exact field shapes, required vs optional, types and enums.
- Response payload: the success and error shapes Carriyo expects back.
- Authentication: Basic, OAuth 2.0, or API-key header. Pick what your platform supports.
Next steps
- Open the live API reference and walk through each operation.
- Review the integration requirements and answer the self-assessment questions.
- Build the endpoints on your side per the spec.
- Share your display name, logo (high-resolution SVG), and a brief description for the Carriyo carrier catalogue.
- Contact Carriyo when your endpoints are ready, both teams will run the sign-off checklist together.