# ShipperHQ

> Get live shipping rates from ShipperHQ for any cart and destination, using your ShipperHQ carriers, rules and origins, read a quote's delivery dates and packages, and place orders with the method chosen.

App · 4 actions. Web page: https://docs.lodol.com/docs/integrations/shipperhq

## Actions

### Estimate shipping

Estimate shipping for a cart in full detail (shipments, delivery dates, packages) without ShipperHQ keeping the quote, for product pages and price checks.

**Inputs**

- Ship to country (`country`, text, required): The country the order ships to. One of: `AF` (Afghanistan (AF)), `AX` (Åland Islands (AX)), `AL` (Albania (AL)), `DZ` (Algeria (DZ)), `AD` (Andorra (AD)), `AO` (Angola (AO)), `AI` (Anguilla (AI)), `AQ` (Antarctica (AQ)), `AG` (Antigua & Barbuda (AG)), `AR` (Argentina (AR)), and 239 more.
- Ship to postal code (`postal_code`, text): The ZIP or postal code it ships to. Most carriers need it to quote.
- Ship to state or region (`region`, text): The state, province or region code, such as TX or ON.
- Ship to city (`city`, text): The city it ships to.
- Ship to street (`street`, text): The street address. Some carriers use it to tell a home from a business.
- Ship to street, line 2 (`street2`, text): The apartment, suite or unit.
- Items (`items`, list, required): One entry per line in the cart, each with its price, weight and quantity.
- Declared value (`declared_value`, number): The value of the whole cart, for carriers that charge by declared value or insurance. At least 0.
- Free shipping (`free_shipping`, true/false): True if the whole cart ships free, as a coupon would make it in your store.
- Customer group (`customer_group`, text): The shopper's customer group, for rules in ShipperHQ that depend on it, such as Wholesale.

**Outputs**

- `errors` (list): The quote's errors, then each carrier's
- `rate_count` (number): How many rates
- `rates` (list): Every method of every shipment with its carrier, each shipment's cheapest first
- `shipment_count` (number): How many shipments
- `shipments` (list): Each shipment: one per origin, with its carriers, packages and dates
- `transaction_id` (text): ShipperHQ's id for this quote, for its support team

**Example output**

```json
{
  "errors": [],
  "rate_count": 1,
  "rates": [
    {
      "carrierCode": "shqups",
      "carrierTitle": "UPS",
      "carrierType": "ups",
      "customsDuties": null,
      "deliveryDate": "2026-10-27",
      "deliveryMessage": "Arrives Tue, Oct 27",
      "dispatchDate": "2026-10-23",
      "handlingFee": 2.0,
      "methodCode": "03",
      "methodTitle": "UPS Ground",
      "shipmentId": "1",
      "shipmentName": "Austin warehouse",
      "shippingPrice": 10.85,
      "totalCharges": 12.85
    }
  ],
  "shipment_count": 1,
  "shipments": [
    {
      "carriers": [
        {
          "availableOptions": {
            "destinationType": "residential",
            "insideDelivery": null,
            "liftGateRequired": null,
            "limitedDelivery": null,
            "notifyRequired": null,
            "options": []
          },
          "calendarDate": {
            "availableDeliveryDates": [
              "2026-10-27",
              "2026-10-28"
            ],
            "deliveryDateRanges": [
              {
                "fromDate": "2026-10-27",
                "toDate": "2026-10-29"
              }
            ],
            "timeSlots": []
          },
          "carrierCode": "shqups",
          "carrierTitle": "UPS",
          "carrierType": "ups",
          "description": null,
          "error": null,
          "packages": [
            {
              "boxedItems": [
                {
                  "itemId": "MUG-1",
                  "qtyPacked": 2,
                  "weightPacked": 2.4
                }
              ],
              "declaredValue": 25.0,
              "height": 6.0,
              "length": 12.0,
              "packingWeight": 0.3,
              "weight": 2.4,
              "width": 10.0
            }
          ],
          "pickupDetail": null,
          "shippingRates": [
            {
              "code": "03",
              "customsDuties": null,
              "customsMessage": null,
              "deliveryDate": "2026-10-27",
              "deliveryMessage": "Arrives Tue, Oct 27",
              "description": null,
              "dispatchDate": "2026-10-23",
              "handlingFee": 2.0,
              "shippingPrice": 10.85,
              "title": "UPS Ground",
              "totalCharges": 12.85
            }
          ],
          "sortOrder": 1
        }
      ],
      "description": null,
      "groupedItems": [
        {
          "itemId": "MUG-1",
          "name": "Mug",
          "qty": 2,
          "sku": "MUG-1"
        }
      ],
      "name": "Austin warehouse",
      "shipmentId": "1"
    }
  ],
  "transaction_id": "SHQ_20261022_2107_rms_1_812"
}
```

### Get quote details

Get the last quote under a session in full: each shipment by origin, delivery and dispatch dates, packages, pickup locations and delivery options.

**Inputs**

- Session (`session_id`, text, required): The session the quote was kept under: the 'session_id' 'Get shipping rates' returned.

**Outputs**

- `errors` (list): The quote's errors, then each carrier's
- `rate_count` (number): How many rates
- `rates` (list): Every method of every shipment with its carrier, each shipment's cheapest first
- `session_id` (text): The session the quote is under
- `shipment_count` (number): How many shipments
- `shipments` (list): Each shipment: one per origin, with its carriers, packages and dates
- `transaction_id` (text): ShipperHQ's id for this quote, for its support team
- `updated_at` (text): When the quote was made

**Example output**

```json
{
  "errors": [],
  "rate_count": 1,
  "rates": [
    {
      "carrierCode": "shqups",
      "carrierTitle": "UPS",
      "carrierType": "ups",
      "customsDuties": null,
      "deliveryDate": "2026-10-27",
      "deliveryMessage": "Arrives Tue, Oct 27",
      "dispatchDate": "2026-10-23",
      "handlingFee": 2.0,
      "methodCode": "03",
      "methodTitle": "UPS Ground",
      "shipmentId": "1",
      "shipmentName": "Austin warehouse",
      "shippingPrice": 10.85,
      "totalCharges": 12.85
    }
  ],
  "session_id": "lodol-3f2a9c1e5b7d4e8f9a0b1c2d3e4f5a6b",
  "shipment_count": 1,
  "shipments": [
    {
      "carriers": [
        {
          "availableOptions": {
            "destinationType": "residential",
            "insideDelivery": null,
            "liftGateRequired": null,
            "limitedDelivery": null,
            "notifyRequired": null,
            "options": []
          },
          "calendarDate": {
            "availableDeliveryDates": [
              "2026-10-27",
              "2026-10-28"
            ],
            "deliveryDateRanges": [
              {
                "fromDate": "2026-10-27",
                "toDate": "2026-10-29"
              }
            ],
            "timeSlots": []
          },
          "carrierCode": "shqups",
          "carrierTitle": "UPS",
          "carrierType": "ups",
          "description": null,
          "error": null,
          "packages": [
            {
              "boxedItems": [
                {
                  "itemId": "MUG-1",
                  "qtyPacked": 2,
                  "weightPacked": 2.4
                }
              ],
              "declaredValue": 25.0,
              "height": 6.0,
              "length": 12.0,
              "packingWeight": 0.3,
              "weight": 2.4,
              "width": 10.0
            }
          ],
          "pickupDetail": null,
          "shippingRates": [
            {
              "code": "03",
              "customsDuties": null,
              "customsMessage": null,
              "deliveryDate": "2026-10-27",
              "deliveryMessage": "Arrives Tue, Oct 27",
              "description": null,
              "dispatchDate": "2026-10-23",
              "handlingFee": 2.0,
              "shippingPrice": 10.85,
              "title": "UPS Ground",
              "totalCharges": 12.85
            }
          ],
          "sortOrder": 1
        }
      ],
      "description": null,
      "groupedItems": [
        {
          "itemId": "MUG-1",
          "name": "Mug",
          "qty": 2,
          "sku": "MUG-1"
        }
      ],
      "name": "Austin warehouse",
      "shipmentId": "1"
    }
  ],
  "transaction_id": "SHQ_20261022_2107_rms_1_812",
  "updated_at": "2026-10-22T21:07:12.000Z"
}
```

### Get shipping rates

Get live shipping rates for a cart from your ShipperHQ carriers and rules, cheapest first. ShipperHQ keeps the quote under the returned session, for 'Place order'.

**Inputs**

- Ship to country (`country`, text, required): The country the order ships to. One of: `AF` (Afghanistan (AF)), `AX` (Åland Islands (AX)), `AL` (Albania (AL)), `DZ` (Algeria (DZ)), `AD` (Andorra (AD)), `AO` (Angola (AO)), `AI` (Anguilla (AI)), `AQ` (Antarctica (AQ)), `AG` (Antigua & Barbuda (AG)), `AR` (Argentina (AR)), and 239 more.
- Ship to postal code (`postal_code`, text): The ZIP or postal code it ships to. Most carriers need it to quote.
- Ship to state or region (`region`, text): The state, province or region code, such as TX or ON.
- Ship to city (`city`, text): The city it ships to.
- Ship to street (`street`, text): The street address. Some carriers use it to tell a home from a business.
- Ship to street, line 2 (`street2`, text): The apartment, suite or unit.
- Items (`items`, list, required): One entry per line in the cart, each with its price, weight and quantity.
- Declared value (`declared_value`, number): The value of the whole cart, for carriers that charge by declared value or insurance. At least 0.
- Free shipping (`free_shipping`, true/false): True if the whole cart ships free, as a coupon would make it in your store.
- Customer group (`customer_group`, text): The shopper's customer group, for rules in ShipperHQ that depend on it, such as Wholesale.
- Session (`session_id`, text): An id to keep the quote under, such as your cart's id. Leave empty to have one made for you.

**Outputs**

- `carriers` (list): Each carrier with its methods, as ShipperHQ sends them
- `cheapest_rate` (object): The cheapest rate; empty when there are none
- `errors` (list): The quote's errors, then each carrier's
- `rate_count` (number): How many rates
- `rates` (list): Every shipping method with its carrier, cheapest first
- `session_id` (text): The session the quote is kept under, for 'Place order'
- `transaction_id` (text): ShipperHQ's id for this quote, for its support team

**Example output**

```json
{
  "carriers": [
    {
      "carrierCode": "shqups",
      "carrierTitle": "UPS",
      "carrierType": "ups",
      "error": null,
      "shippingRates": [
        {
          "code": "03",
          "currency": "USD",
          "title": "UPS Ground",
          "totalCharges": 12.85
        },
        {
          "code": "02",
          "currency": "USD",
          "title": "UPS 2nd Day Air",
          "totalCharges": 29.4
        }
      ]
    },
    {
      "carrierCode": "shqfreight",
      "carrierTitle": "LTL Freight",
      "carrierType": "freight",
      "error": {
        "errorCode": 304,
        "externalErrorMessage": "This shipping method is currently unavailable.",
        "internalErrorMessage": "Carrier not available for destination country",
        "priority": 2
      },
      "shippingRates": []
    }
  ],
  "cheapest_rate": {
    "carrierCode": "shqups",
    "carrierTitle": "UPS",
    "carrierType": "ups",
    "currency": "USD",
    "methodCode": "03",
    "methodTitle": "UPS Ground",
    "totalCharges": 12.85
  },
  "errors": [
    {
      "carrierCode": "shqfreight",
      "errorCode": 304,
      "externalErrorMessage": "This shipping method is currently unavailable.",
      "internalErrorMessage": "Carrier not available for destination country",
      "priority": 2
    }
  ],
  "rate_count": 2,
  "rates": [
    {
      "carrierCode": "shqups",
      "carrierTitle": "UPS",
      "carrierType": "ups",
      "currency": "USD",
      "methodCode": "03",
      "methodTitle": "UPS Ground",
      "totalCharges": 12.85
    },
    {
      "carrierCode": "shqups",
      "carrierTitle": "UPS",
      "carrierType": "ups",
      "currency": "USD",
      "methodCode": "02",
      "methodTitle": "UPS 2nd Day Air",
      "totalCharges": 29.4
    }
  ],
  "session_id": "lodol-3f2a9c1e5b7d4e8f9a0b1c2d3e4f5a6b",
  "transaction_id": "SHQ_20261022_2107_rms_1_812"
}
```

### Place order

Turn the quote under a session into an order in ShipperHQ, with the shipping method the shopper chose, so it shows in ShipperHQ's order details.

**Inputs**

- Session (`session_id`, text, required): The session the quote was kept under: the 'session_id' 'Get shipping rates' returned.
- Order number (`order_number`, text, required): Your store's order number. ShipperHQ files the order under it.
- Carrier code (`carrier_code`, text, required): The chosen rate's 'carrierCode', from 'Get shipping rates'.
- Method code (`method_code`, text, required): The chosen rate's 'methodCode', from 'Get shipping rates'.
- Shipping charged (`total_charges`, number, required): What the shopper paid for shipping: the rate's 'totalCharges'. At least 0.
- Order date (`order_date`, date and time): When the order was placed. Leave empty for an order just placed.
- Recipient first name (`first_name`, text): The first name of the person the order ships to.
- Recipient last name (`last_name`, text): Their last name.
- Recipient company (`company`, text): The company it ships to, if any.
- Recipient email (`email`, text): The recipient's email address.
- Recipient phone (`phone`, text): The recipient's phone number.
- Recipient street (`street`, text): The street address it ships to.
- Recipient street, line 2 (`street2`, text): The apartment, suite or unit.
- Recipient city (`city`, text): The city it ships to.
- Recipient state or region (`region`, text): The state, province or region code, such as TX or ON.
- Recipient postal code (`postal_code`, text): The ZIP or postal code it ships to.
- Recipient country (`country`, text): The country it ships to. One of: `AF` (Afghanistan (AF)), `AX` (Åland Islands (AX)), `AL` (Albania (AL)), `DZ` (Algeria (DZ)), `AD` (Andorra (AD)), `AO` (Angola (AO)), `AI` (Anguilla (AI)), `AQ` (Antarctica (AQ)), `AG` (Antigua & Barbuda (AG)), `AR` (Argentina (AR)), and 239 more.

**Outputs**

- `carrier_code` (text): The carrier chosen
- `method_code` (text): The method chosen
- `order_number` (text): The order number
- `placed` (true/false): True once placed
- `response_code` (number): The number ShipperHQ answered with
- `session_id` (text): The session the order was placed from
- `total_charges` (number): The shipping charged

**Example output**

```json
{
  "carrier_code": "shqups",
  "method_code": "03",
  "order_number": "100045",
  "placed": true,
  "response_code": 1,
  "session_id": "lodol-3f2a9c1e5b7d4e8f9a0b1c2d3e4f5a6b",
  "total_charges": 12.85
}
```
