Docs
Sign in

Integration options

Updated May 26, 20262 min read

Carriyo connects merchants to carriers through a single API and Dashboard. To add your carrier to that network, choose one of two integration paths.

The preferred path is Plug & Play: your team implements the Carriyo Plug & Play API spec on your side, and Carriyo's connector calls your endpoints. The alternative is a custom integration: you share your existing API documentation and the Carriyo team builds a connector tailored to your API.

Plug & play

With Plug & Play, your team builds against Carriyo's published spec. You own the implementation and control the pace. Carriyo's connector calls your endpoints once they're live.

Carriyo recommends Plug & Play for three reasons:

  • You ship on your schedule: your team controls the timeline without waiting on Carriyo's build queue.
  • The spec is complete: it covers all shipment information Carriyo needs. You can start with the fields you use today and extend later.
  • You own the integration: when your requirements change, your team updates the implementation directly.

Custom integration

If you can't implement the Plug & Play spec, share your existing API documentation and Carriyo will build a custom connector tailored to your API.

A connector enables core shipping operations: booking shipments, generating labels, scheduling pickups, and tracking shipment statuses.

Before Carriyo can begin, your team needs to provide:

  • Full API documentation and any other developer resources.
  • Access to your test environment, test account, and API credentials.
  • Display name, logo (high-resolution SVG), and a brief description of your service for the Carriyo carrier catalogue.
  • Your status list mapped to Carriyo statuses.
  • Your city and area list mapped to the Carriyo Geo List.

Review the integration requirements and answer the self-assessment questions. Consolidate your answers in a document and share it with your Carriyo contact before reaching out.

What happens next (custom path)

  1. Your team shares the documentation and materials listed above.
  2. The Carriyo team reviews and schedules a discovery call to clarify open points and agree on any changes needed on your side.
  3. The Carriyo team builds the connector. Your team supports the integration during this period.
  4. Both teams test the connector together and sign it off.
  5. The connector is deployed and your carrier is live on Carriyo.