Connect an OSM Worldwide account in ShipHero to start generating labels and pulling live rates. You'll need five credentials from OSM before you begin.
Before You Begin
- OSM credentials: Get these five credentials from your OSM Worldwide account representative: a Client ID, an API Key, a Rating Key, a Mailer ID (MID), and your OSM Destination facility code.
- OSM return address: Have the return address OSM requires for your account ready. You enter it when you connect OSM, and OSM prints it on every label.
For a full breakdown of what OSM supports in ShipHero, see Overview: OSM in ShipHero.
Table of Contents
- Getting the OSM Connection Credentials
- How to Connect OSM to ShipHero
- Available OSM Settings After Connecting
Getting the OSM Connection Credentials
OSM Worldwide issues all five connection credentials directly. Contact your OSM account representative to request your Client ID, API Key, Rating Key, and Mailer ID (MID). Confirm which OSM facility your packages ship from too, since that determines your OSM Destination code.
OSM Destination Facility Codes
| Code | Facility | State |
|---|---|---|
| 1 | Glendale Heights | IL |
| 2 | York | PA |
| 3 | North Las Vegas | NV |
| 4 | Austell | GA |
| 5 | Grand Prairie | TX |
How to Connect OSM to ShipHero
- Go to Shipping > Carriers and select Add Carrier.
- Select OSM Worldwide from the carrier list.
- Enter your Client ID, API Key, Rating Key, Mailer ID (MID), and OSM Destination code.
- Save the connection. ShipHero verifies the credentials and adds the OSM Worldwide account to your carrier list.
Required OSM Connection Fields
| Field | Description |
|---|---|
| Client ID (Required) | OSM-assigned identifier for your account. |
| API Key (Required) | Authenticates label creation through the OSM Label API and rate requests through the Rating API. |
| Rating Key (Required) | A separate credential OSM issues specifically for the Rating API. It doesn't work for label creation. |
| Mailer ID (MID) (Required) | Your 9-digit OSM Mailer ID. |
| OSM Destination (Required) | The one-character code for the OSM facility your packages ship from. See the facility code table above. |
Important
OSM requires a specific return address for your account. Enter that address when you connect OSM to ShipHero. OSM uses it on every label instead of your default ShipHero return address, even if the two don't match.
Available OSM Settings After Connecting
After you connect an OSM account, enable the shipping methods you want available for orders.
Important Reminders when Connecting a Carrier Account
- Using Custom Profiles: Custom profiles allow you to connect the same carrier account multiple times with unique settings, such as specific Incoterms or 3rd Party Billing. For these settings to apply, the order must be assigned to that specific profile. If the assigned profile lacks a connected carrier, ShipHero will automatically use the carrier account connected the warehouse’s default profile for the selected shipping method. This ensures your specialized billing and shipping terms are applied correctly to every label. Visit the following article for more information on How to Use Warehouse Profiles.
- Multi-Warehouse Accounts: To generate labels from multiple warehouses, you must connect your carrier account to each individual location in ShipHero to avoid shipping errors or billing discrepancies. Please consult your carrier to determine if a single account number supports multiple origins or if unique accounts are required for each site. This is especially critical for international locations, as carrier operations vary by country.
- Note for 3PLs: When connecting a new carrier account to ShipHero, double check your 3PL Clients' Settings to ensure you are connecting the carrier account to the correct ShipHero account; if Use Customer's Shipping Accounts is enabled the carrier account must be connected at the child account level, if Use Customer's Shipping Account is not enabled, the carrier account needs to be enabled at the 3PL level. More information about Managing 3PL Client Settings can be found here.