Integration Options

Our preferred method for integrating a carrier into the Carriyo platform is through the Carriyo Plug & Play specification. The spec provides a simple standard for carrier integration, enabling the carriers to build the integration on their side and join our platform with ease.

In some cases, where a carrier is unable to integrate using the Carriyo Plug & Play specification, we are able to offer the option to design and build a Custom Integration that is specifically tailored for the carrier API.

Plug & Play

The Carriyo Plug & Play specification is desgined to empower carriers to quickly onboard themselves to the carrier platform. The carrier team can use our specification to build the integration on their side, rather than waiting on the Carriyo team to build the integration. We recommend the Plug & Play specification for the following reasons

  • Quicker time to market - Using the Carriyo specification enables quick and seamless integration path to Carriyo.
  • Detailed Specification - The Carriyo specification includes all the shipment information, and is therefore complete in terms of the information it can provide to the carrier.
  • Future Changes - The carrier team has more control over the integration and can easily update the integration in the future as their requirements change. They can also extend their model and consume new information in the future, even if they don't use all the information from the Carriyo specification at the start.

Custom Integration

Although our preferred method for carrier integration is the the Plug & Play specification, we do appreciate that it is not always possible for carriers to build the integration on their side, In such cases, we can integrate using your API. However, to enable robust integration, the Carriyo team needs to understand the carrier API in detail. We generally need a full documentation from the carrier team along with access to their test environment to build the connector.

A carrier connector enables various shipping operations, such as booking shipments, generating labels, scheduling pickups, and tracking shipment statuses.

If you are unable to use the Carriyo Plug & Play specification and would like Carriyo to build a custom connector, then please reach out to us once you have completed the steps below:

  • Review all questions under "Integration Requirements" in this guide and answer all questions highlighted. Please consolidate your responses in a document and share with your primary contact in Carriyo.
  • Share all API documentation and any other developer resources.
  • Share access to your test environment, URL test account and API credentials.
  • Share display name, logo (high-resolution SVG) and a brief description of your service to represent your brand on the Carriyo platform.
  • Download the Carriyo status list and map your statuses to the Carriyo list.
  • Download the Carriyo Geo List of cities and areas and map your list to the Carriyo list.

Next Steps for Integration

  1. Carrier team will share all the information in the above checklist.
  2. Carriyo team will review and schedule a discovery call to clarify open points and agree any changes required on the carrier side to meet Carriyo's requirements.
  3. Carriyo team will start implementing the connector on it's platform, while the carrier team will continue supporting the integration.
  4. Once development is completed, both teams will test the connector to sign off the integration.
  5. Upon sign off from both sides, the connector will be deployed on the Carriyo platform.