Create and manage shipments.

The Shipments API is the core of the RC:Ship platform. Creating a shipment automatically selects the carrier (via routing rules), manifests the package with the carrier, generates a label, and initiates tracking.

Create a Shipment

You can create a shipment by either providing a previously retrieved rateId, or by explicitly passing the destination and package data and allowing RC:Ship's engine to select the best carrier.

{
  "orderId": "ORD-2024-998",
  "carrier": "amazon_shipping",
  "service": "standard",
  "destination": {
    "name": "Jane Doe",
    "address1": "456 Tech Park",
    "city": "Bengaluru",
    "state": "KA",
    "zip": "560001",
    "country": "IN",
    "phone": "+919876543210"
  },
  "packages": [
    {
      "weight": 2.5,
      "dimensions": { "length": 20, "width": 15, "height": 10, "unit": "cm" }
    }
  ]
}

The Shipment Response

Upon successful creation, the API returns the manifested shipment details, including the carrier's tracking number and a URL to download the generated shipping label.

{
  "id": "shp_a1b2c3d4",
  "status": "created",
  "orderId": "ORD-2024-998",
  "carrier": "amazon_shipping",
  "service": "standard",
  "trackingNumber": "AMZ987654321",
  "labelUrl": "https://api.ship.retailcoder.com/v1/labels/shp_a1b2c3d4.pdf",
  "createdAt": "2024-05-18T14:30:00Z"
}

Retrieve a Shipment

You can retrieve the full details of a previously created shipment, including its current status, by making a GET request to the shipment endpoint using the shp_... identifier.