Create a shipping quote

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

Request Body

application/jsonRequired

shipToAddressRequiredobject

Destination shipping address

shipFromAddressRequiredobject

Origin shipping address

packagesRequiredarray<object>

Packages to get rates for

shippingDatestring

Date the shipment will be sent (defaults to current date/time)

Format: "date-time"

curl -X POST "https://www.shipsidekick.com/api/v1/shipping-quotes" \
  -H "Content-Type: application/json" \
  -d '{
    "shipToAddress": {
      "name": "John Doe",
      "company": "Example Corp",
      "street1": "123 Main St",
      "street2": "Apt 4B",
      "city": "San Francisco",
      "state": "CA",
      "postalCode": "94102",
      "country": "US",
      "phone": "555-1234",
      "email": "john@example.com",
      "isResidential": true
    },
    "shipFromAddress": {
      "name": "Warehouse Team",
      "company": "ShipSidekick",
      "street1": "456 Industrial Way",
      "city": "Los Angeles",
      "state": "CA",
      "postalCode": "90210",
      "country": "US",
      "phone": "555-5678",
      "isResidential": false
    },
    "packages": [
      {
        "weight": 16,
        "weightUnit": "oz",
        "dimensions": {
          "length": 12,
          "width": 8,
          "height": 4
        },
        "dimensionsUnit": "in"
      }
    ],
    "shippingDate": "2024-01-15T10:00:00Z"
  }'

Shipping quote created successfully

{
  "object": "shipping_quote",
  "data": {
    "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"
  }
}

Create a shipping quote

Request Body

Response

TypeScript