Shipsidekick LogoShipsidekick Docs
API/Shipments

Get shipment by ID

Retrieve a specific shipment by its unique identifier. Results are filtered to shipments the authenticated user has access to.

GET
/shipments/{shipmentId}

Path Parameters

shipmentIdRequiredstring

Unique identifier of the shipment

Format: "uuid"
curl -X GET "https://www.shipsidekick.com/api/v1/shipments/abcd1234-e89b-12d3-a456-426614174000"

Successful operation

{
  "object": "shipment",
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
    "trackingCode": "string",
    "returnAddress": {
      "name": "string",
      "company": "string",
      "street1": "string",
      "street2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string",
      "phone": "string",
      "email": "string"
    },
    "carrierAccount": {
      "carrierCode": "string",
      "description": "string"
    },
    "shippingQuote": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
      "shipToAddress": {
        "name": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string",
        "phone": "string",
        "email": "string",
        "facilityCode": "string",
        "isResidential": true,
        "isVerified": true,
        "taxIdentifier": "string"
      },
      "shipFromAddress": {
        "name": "string",
        "company": "string",
        "street1": "string",
        "street2": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string",
        "phone": "string",
        "email": "string",
        "facilityCode": "string",
        "isResidential": true,
        "isVerified": true,
        "taxIdentifier": "string"
      },
      "shippingDate": "2019-08-24T14:15:22Z",
      "messages": [
        "string"
      ],
      "packages": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "weight": 0.1,
          "weightUnit": "string",
          "dimensions": {
            "length": 0.1,
            "width": 0.1,
            "height": 0.1
          },
          "dimensionsUnit": "string",
          "packaging": {
            "name": "string",
            "type": "string"
          }
        }
      ],
      "shippingRates": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "serviceCode": "string",
          "rateTotal": 0,
          "rateSurcharges": 0.1,
          "compareAtRate": 0,
          "currency": "string",
          "estDeliveryDays": 0,
          "estDeliveryDate": "2019-08-24T14:15:22Z",
          "deliveryDateGuaranteed": true,
          "message": "string",
          "carrierAccount": {
            "carrierCode": "string",
            "description": "string"
          }
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    },
    "shippingRate": {
      "serviceCode": "string",
      "rateTotal": 0,
      "currency": "string",
      "estDeliveryDays": 0,
      "estDeliveryDate": "2019-08-24T14:15:22Z"
    },
    "tracker": {
      "status": "string",
      "statusDetail": "string",
      "estDeliveryDate": "2019-08-24T14:15:22Z",
      "trackingUrl": "string"
    },
    "order": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string"
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Create a shipment POST

Create a new shipment directly by providing shipping details and selecting a carrier and service. This creates a shipping quote internally and purchases the label in one step.

List shipments GET

Retrieve a list of shipments with pagination and filtering options. Results are filtered to shipments the authenticated user has access to.