ShipperHQ
App · 4 actions
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.
Actions
| Action | What it does |
|---|---|
| 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. |
| 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. |
| Get shipping rates | Get live shipping rates for a cart from your ShipperHQ carriers and rules, cheapest first. |
| 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. |
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
countrytextRequired - 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_codetext - The ZIP or postal code it ships to. Most carriers need it to quote.
- Ship to state or region
regiontext - The state, province or region code, such as TX or ON.
- Ship to city
citytext - The city it ships to.
- Ship to street
streettext - The street address. Some carriers use it to tell a home from a business.
- Ship to street, line 2
street2text - The apartment, suite or unit.
- Items
itemslistRequired - One entry per line in the cart, each with its price, weight and quantity.
- Declared value
declared_valuenumber - The value of the whole cart, for carriers that charge by declared value or insurance.At least 0.
- Free shipping
free_shippingtrue/false - True if the whole cart ships free, as a coupon would make it in your store.
- Customer group
customer_grouptext - The shopper's customer group, for rules in ShipperHQ that depend on it, such as Wholesale.
Outputs
errorslist- The quote's errors, then each carrier's
rate_countnumber- How many rates
rateslist- Every method of every shipment with its carrier, each shipment's cheapest first
shipment_countnumber- How many shipments
shipmentslist- Each shipment: one per origin, with its carriers, packages and dates
transaction_idtext- ShipperHQ's id for this quote, for its support team
Example output
{
"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_idtextRequired - The session the quote was kept under: the 'session_id' 'Get shipping rates' returned.
Outputs
errorslist- The quote's errors, then each carrier's
rate_countnumber- How many rates
rateslist- Every method of every shipment with its carrier, each shipment's cheapest first
session_idtext- The session the quote is under
shipment_countnumber- How many shipments
shipmentslist- Each shipment: one per origin, with its carriers, packages and dates
transaction_idtext- ShipperHQ's id for this quote, for its support team
updated_attext- When the quote was made
Example output
{
"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
countrytextRequired - 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_codetext - The ZIP or postal code it ships to. Most carriers need it to quote.
- Ship to state or region
regiontext - The state, province or region code, such as TX or ON.
- Ship to city
citytext - The city it ships to.
- Ship to street
streettext - The street address. Some carriers use it to tell a home from a business.
- Ship to street, line 2
street2text - The apartment, suite or unit.
- Items
itemslistRequired - One entry per line in the cart, each with its price, weight and quantity.
- Declared value
declared_valuenumber - The value of the whole cart, for carriers that charge by declared value or insurance.At least 0.
- Free shipping
free_shippingtrue/false - True if the whole cart ships free, as a coupon would make it in your store.
- Customer group
customer_grouptext - The shopper's customer group, for rules in ShipperHQ that depend on it, such as Wholesale.
- Session
session_idtext - An id to keep the quote under, such as your cart's id. Leave empty to have one made for you.
Outputs
carrierslist- Each carrier with its methods, as ShipperHQ sends them
cheapest_rateobject- The cheapest rate; empty when there are none
errorslist- The quote's errors, then each carrier's
rate_countnumber- How many rates
rateslist- Every shipping method with its carrier, cheapest first
session_idtext- The session the quote is kept under, for 'Place order'
transaction_idtext- ShipperHQ's id for this quote, for its support team
Example output
{
"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_idtextRequired - The session the quote was kept under: the 'session_id' 'Get shipping rates' returned.
- Order number
order_numbertextRequired - Your store's order number. ShipperHQ files the order under it.
- Carrier code
carrier_codetextRequired - The chosen rate's 'carrierCode', from 'Get shipping rates'.
- Method code
method_codetextRequired - The chosen rate's 'methodCode', from 'Get shipping rates'.
- Shipping charged
total_chargesnumberRequired - What the shopper paid for shipping: the rate's 'totalCharges'.At least 0.
- Order date
order_datedate and time - When the order was placed. Leave empty for an order just placed.
- Recipient first name
first_nametext - The first name of the person the order ships to.
- Recipient last name
last_nametext - Their last name.
- Recipient company
companytext - The company it ships to, if any.
- Recipient email
emailtext - The recipient's email address.
- Recipient phone
phonetext - The recipient's phone number.
- Recipient street
streettext - The street address it ships to.
- Recipient street, line 2
street2text - The apartment, suite or unit.
- Recipient city
citytext - The city it ships to.
- Recipient state or region
regiontext - The state, province or region code, such as TX or ON.
- Recipient postal code
postal_codetext - The ZIP or postal code it ships to.
- Recipient country
countrytext - 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_codetext- The carrier chosen
method_codetext- The method chosen
order_numbertext- The order number
placedtrue/false- True once placed
response_codenumber- The number ShipperHQ answered with
session_idtext- The session the order was placed from
total_chargesnumber- The shipping charged
Example output
{
"carrier_code": "shqups",
"method_code": "03",
"order_number": "100045",
"placed": true,
"response_code": 1,
"session_id": "lodol-3f2a9c1e5b7d4e8f9a0b1c2d3e4f5a6b",
"total_charges": 12.85
}