Integration by Use Cases
You can achieve a basic integration with Carriyo using two main endpoints: one for sending shipment information to Carriyo and another for receiving status updates from Carriyo via webhooks. The guides below cover different integration patterns depending on your setup and requirements.
-
Integrate E-commerce Orders
Create draft shipments when customer orders are received, then confirm them after picking and packing. Best for e-commerce merchants who don't use a separate WMS/OMS and want visibility from order receipt.
-
Integrate WMS or OMS
Create confirmed shipments directly after fulfillment in your warehouse or order management system. Best when items are already picked and packed before Carriyo is involved.
-
Integrate Pre-Booked Shipments
Send shipments that are already booked with a carrier to Carriyo for tracking, analytics, and customer notifications. Best when you have an existing booking system and want to add Carriyo's post-purchase capabilities.
-
Integrate Reverse Shipments
Create reverse shipments for customer returns, including collection scheduling from the customer's address. Covers the relationship between the Shipping API and the Returns API.
-
Integrate Cross-Border Shipments
Additional data requirements for international shipments — item-level customs data, incoterms, customs parties, registration numbers, and how to configure defaults at the carrier account level.