Use ShipperHQ with Order Management or Fulfillment Software
Integrate detailed shipment data with your fulfillment processes for improved order management efficiency
Table of Contents
- Overview
- Shipping Insights
- General Recommendations
- Alternate Options
- Magento 1
- Magento 2/Adobe Commerce
- BigCommerce
- Shopify
- Support for UPS Access Point
Overview
At ShipperHQ, we know that you have unique business processes that may benefit from the shipment details generated at checkout. Depending on your eCommerce platform, you have several ways to integrate the shipment info from ShipperHQ into your fulfillment processes.
Shipping Insights
The best way to integrate ShipperHQ with your Order Management or Fulfillment Software is through our Shipping Insights feature. This tool provides you with extended shipment details, even if your eCommerce platform has limitations in storing this information. You can access these details with no coding needed in supported platforms like ShipStation and agnoStack. Alternatively, integrate directly using our Insights API to pull information into your fulfillment software.
Shipping Insights is available for certain ShipperHQ plans on:
- Adobe Commerce (Magento 2)
- BigCommerce
- Shopify
If your platform doesn't support Shipping Insights, please contact us. We will inform you if we add support in the future. Learn more about Shipping Insights
General Recommendations
We recommend using the shipping method code field on an order to map and process your orders automatically. For instance, a shipping description might read "USPS Priority Mail", but the shipping method code is "shqusps_priority". This is more reliable than using the description, which might change due to translations or expected delivery dates on your site. The shipping method code remains constant, ensuring consistency.
Alternate Options
If you're not using Shipping Insights or your platform doesn't support it, you'll rely on your eCommerce platform's capabilities to store and access shipment information. These capabilities vary but are described below.
Magento 1
ShipperHQ sets shipping method codes and descriptions on orders. Additional info is stored in custom columns on order tables, accessible through direct calls like $order->getData("liftgate_required")
. Some useful columns in the order table sales_flat_order
are:
carrier_id
carrier_type
dispatch_date
shq_delivery_comments
delivery_date
destination_type
carriergroup_shipping_htm
liftgate_required
notify_required
inside_delivery
freight_quote_id
customer_carrier
customer_carrier_ph
customer_carrier_account
pickup_location
pickup_location_id
time_slot
pickup_latitude
pickup_longitude
limited_delivery
Note: For split or merged rate orders, data will be in the carriergroup_shipping_details
column in JSON format.
Further Information
- Extract all carrier and shipping method codes configured in ShipperHQ
- Modify email templates to display detailed shipping information
Magento 2/Adobe Commerce
Basic shipping info is stored in standard order tables like sales_order
. More details are in ShipperHQ tables such as:
shipperhq_order_detail
: information like dispatch date, delivery date, and moreshipperhq_order_item_detail
: details for each item like carrier groupshipperhq_order_packages
: shipment information including dimensions and weight
Use the helper class ShipperHQ\Shipper\Helper\CarrierGroup
to extract order details.
Note: For extra information beyond standard Magento tables, use Shipping Insights.
- We don't currently support the Magento 2 API. Please contact us with specific requests.
- Read more on extracting carrier and method codes
- Email template customization
BigCommerce
BigCommerce limits shipment information to price, carrier, method name (including delivery dates or duties & taxes if enabled), and method code. These are viewable in orders or via the BigCommerce Orders API. Learn more
Shopify
Shopify stores limited shipment information available via the ShippingLine object in the API. Shopify stores method codes in a specific format using underscores instead of standard carrier codes.
- Carrier Name Example:
shqups1_gnd
becomesUPS_Shipping_gnd
for the carrierUPS Shipping
.
More on Carrier and Method Codes
Support for UPS Access Point
To process orders with UPS Access Point, extract the Location ID from the shipping method in Magento. The format is <carrier>_<method>_<locationId>
e.g., shqupsaccess_GND_U85431561
.