Integrate E-commerce Orders

If you’re not using a fulfillment system such as an OMS or WMS, and you are unable to use one of our pre-built connectors, you can integrate your e-commerce orders via API. In this setup, you will typically create a draft shipment in Carriyo when a customer order is received. A shipment in a draft status allows the merchant to fulfill the items (pick and pack) before confirming the shipment. Once the shipment is confirmed, it is booked with the selected carrier, a tracking number is generated, and a label is produced.

Creating a draft shipment provides early visibility into your shipments from the moment the customer order is received.

Steps for Direct Integration

  1. Create a Draft Shipment : When a customer places an order, create a draft shipment in Carriyo.
    API Endpoint : POST https://api.carriyo.com/shipments?draft=true

    Note: Do not include the draft parameter for confirmed shipments

  2. Confirm the Shipment : After picking and packing the items, confirm the shipment in Carriyo to book it and generate the label. This can be done through the Carriyo Dashboard if you don’t have a separate system for fulfillment and label printing. At this stage, you'll also update the parcel details for the shipment. Alternatively, perform this step via API once the shipment is confirmed.

    API Endpoint: POST https://api.carriyo.com/shipments/{shipment-id}/confirm