Shipsidekick LogoShipsidekick Docs
API/Shipping quotes

Create shipment from quote

Create a shipment from an existing shipping quote by selecting a carrier and service code.

POST
/shipping-quotes/{shippingQuoteId}

Request Body

application/jsonRequired
carrierCodeRequiredstring

Carrier code to use for shipping

serviceCodeRequiredstring

Service code to use for shipping

customsInputobject

Customs information for international shipments

labelFormatstring

Label format for the shipping label (e.g., PDF, PNG, ZPL)

zplDpinumber

DPI setting for ZPL labels

Path Parameters

shippingQuoteIdRequiredstring

Unique identifier of the shipping quote

Format: "uuid"
curl -X POST "https://www.shipsidekick.com/api/v1/shipping-quotes/497f6eca-6276-4993-bfeb-53cbbbba6f08" \
  -H "Content-Type: application/json" \
  -d '{
    "carrierCode": "usps",
    "serviceCode": "priority",
    "labelFormat": "pdf"
  }'

Shipment created successfully from quote

{
  "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"
  }
}

List purchase orders GET

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

Create a shipping quote POST

Create a new shipping quote and return available shipping rates. Requires full write access to shipping.