How to configure Obibox v2 (OBIBOXV2) in techSHIP [Guide]

The Obibox v2 integration supports:

• Rate Shopping

• Tracking History

• Time in Transit

Information to be Provided

The following credentials and data points are mandatory to connect to Obibox v2. Ensure you have these items available before starting the setup:

To ship for a specific subclient/store, also obtain its Sub-client ID from Obibox and ensure it has a default pickup address configured with the carrier. This setup requires the parent organization's API key; a subclient's own key cannot be used for this flow.

If you need a specific registered pickup address without a subclient, obtain its pickup-address UUID from Obibox. This identifier is optional.

Specifications and Constraints

Operational Details

Obibox v2 supports Canadian domestic small parcel shipments, with 1–20 packages per order. Rates are returned in CAD.

Time in Transit is calculated from the carrier's estimated delivery date and the current date in the portal's time zone, using calendar days with a minimum of one day. Same-day and next-day estimates both return one day. The carrier's estimate already accounts for holidays and closed days; techSHIP does not add a separate adjustment.

• Recipient phone: Provide a Canadian or US 10-digit number, optionally prefixed with +1. Phone extensions are not sent to the carrier.

• Carrier cancellation: Voiding an order in techSHIP does not cancel the shipment with Obibox. Handle the carrier cancellation in the Obibox portal.

Configuring a Baseline Account

A Baseline Account serves as the fundamental connection point between techSHIP and the carrier's system. It acts as a template that holds the credentials and fundamental properties required to process shipments.

The techSHIP AI Assistant is available from the Carrier page for supported Carrier configuration tasks. For detailed conceptual information and advanced configuration, refer to 📄 techSHIP AI Assistant: Overview & Availability [Information].

Adding a Carrier

Before adding an account, you must ensure the Carrier entity is available for your location.

1. Click My Carriers from the left menu under the Carriers category.

2. Click Add Carrier.

   

3. Select the desired Carrier.

You may encounter additional messages depending on the carrier status or your plan:

• Subscription Required (⭐): If the carrier has a star icon, you will see a message stating "To use this carrier, a subscription upgrade is required." Press Contact to Upgrade to proceed.

  

• Carrier Suspended: If the carrier has not been used for an extended period, you will see a message stating “This carrier is currently on hold...” Click Request Assistance to reactivate it.

  

• Setup Fee Waived: If a carrier from the same carrier group is already installed in your location, you can add this carrier without incurring additional fees.

  

4. If needed, update the carrier Name.

5. Click Add Carrier.

   

If the purchase confirmation appears, complete the following steps:

• Review the purchase notice and any applicable charge information.

• Optionally enter a PO Number.

• Select I am authorized to complete this purchase on behalf of my organization.

• Click Purchase to confirm the Carrier addition.

Once the Carrier is added, you will be automatically redirected to the Carrier page to continue setting it up.

6. Enter the Code of the Carrier as it appears in your host system.

The Code of the Carrier must match exactly the value defined in the host system. Any discrepancy (including casing or extra spaces) may prevent the carrier from working correctly.

7. Click Save.

   

If your facility utilizes the centralized Pickup Schedule, we highly recommend adding this new carrier to your calendar now. While not required to process labels, this ensures accurate induction metrics for your Insights dashboards. To learn more, see 📄 Understanding the Centralized Pickup Schedule & Expected Induction Logic [Information].

Adding a Baseline Account

From the Carrier page, click Add Account to create a new Baseline Account.

You will be redirected to the Baseline Account page to complete the setup.

Entering incorrect values will prevent the system from generating shipping labels.

General Tab

In the General tab, define the administrative properties:

• Name: Enter a descriptive name for the account.

Enter a descriptive name based on unique properties. E.g.:

• Carrier Name - Account Number (CarrierX - 123456789)

• Carrier Name - Consolidator Name (CarrierY - MyConsolidator)

• Carrier Name

• Usage: Select the most suitable option:

  • Test: Used for sandbox or onboarding purposes.

  • Production: Used for live shipping.

Keep the Status field set to its default Active value. An account must be Active to remain fully editable. For detailed conceptual information on account statuses, refer to 📄 How to Inactivate and Activate a Carrier Baseline Account [Step-by-Step Guide].

Carrier Tab

Connection and Pickup

• API key: Enter the key for the required environment. When a Client Account uses Sub-client ID, enter the parent organization's key here.

• Pickup Address ID: Optionally enter an Obibox pickup-address UUID. This setting applies only when the Client Account's Sub-client ID is blank. A populated Pickup Address ID override on the Client Account takes precedence. If both pickup identifiers are blank, Obibox uses the API-key organization's default pickup address.

Sender Address

In Sender address, configure Address 1, City, State/province, Zip, and Country for the ship-from address. Use Address 2 and Address 3 when needed.

Sender city, province, postal code, and country remain required for rating even when a subclient is configured. For subclient shipments, Obibox uses the subclient's registered default pickup address for pricing and shipment creation.

Labels Tab

Supported label format: PDF. Other label preferences are not supported by Obibox v2.

Labels are retrieved for each package after the carrier assigns its tracking number. If the carrier has not finished preparing the label, retrieval may remain pending.

Finalizing the Setup

Once you have entered the required information, click Save.

After you save the Baseline Account, check whether the Registration tab or a registration status badge is available.

If neither is available, the Carrier does not use this Registration workflow in techSHIP. If registration is still pending, open the Registration tab and press Registration, then complete 📄 How to Register a Carrier Baseline Account [Step-by-Step Guide] before creating shipments.

From the Carrier page, you can now see the Baseline Account listed with the administrative status Active. The Active status is separate from the account's registration status.

The Baseline Account configuration is now saved. You can continue with Configuring a Client Account below to assign the Baseline Account to a specific Client.

Configuring a Client Account

Adding an Account

Before adding a Client Account, ensure that the Client has been created. For instructions creating a Client, see: 📄 10 - How to create a Client profile [Step-by-Step guide].

1. Click Clients from the left menu under the Clients section.

2. Click the Edit icon for the desired Client.

   

3. Click Add Accounts.

   

4. Optionally, use the Search box to search by Baseline Account Name or Carrier.

5. Select the Baseline Accounts that will serve as the foundation for your new Client Accounts.

6. Click Add Accounts.

   

   A toast notification will confirm the accounts were successfully assigned. Click the Refresh icon if recently added accounts are not displayed.

   

7. Click Edit on each newly created account.

   

8. Configure the available options in each tab (except Carrier).

   

For complete instructions on configuring this settings, see 📄 How to configure the Billing Account General Options tab [Step-by-Step guide].

Carrier Tab

Service and Subclient

• Service code: Select Default, or select [Use Order] when the service is selected at order level.

• Override WMS Service Code: Enable this setting when the Client Account's Service code must override the service received from the Integrated system.

• Sub-client ID: Optionally enter the Obibox subclient/store identifier. Rates and shipments will use this subclient under the parent organization authenticated by the Baseline Account's API key. Leave blank to continue shipping under the organization identified by the key.

• Pickup Address ID override: Optionally enter a client-specific pickup-address UUID. When Sub-client ID is blank, this overrides the Baseline Account's Pickup Address ID. When Sub-client ID is populated, neither pickup identifier is used; the shipment uses the subclient's default pickup address configured with Obibox.

Sender Address Override

Enable Override sender address to configure a client-specific sender address using Address 1, Address 2, Address 3, City, State/province, Zip, and Country. This does not change the subclient's registered default pickup address with Obibox.

Specifying Rate Shopping Service Codes

Obibox v2 supports Rate Shopping using service code Default. The transit calculation does not add separate Same Day or Next Day service codes.

For detailed instructions on how to configure this, see: Include or exclude Service Codes when Rate Shopping [Step-by-Step Guide].

Finalizing the Setup

Once you have entered the required information, click Save.

With the account configured and requirements verified, you can now proceed to process orders as described below.

Configuring an Order

The steps described in this section are not required for carrier setup, and they are offered as an optional review if further order-level configuration is required.

Follow the UI Navigation steps in 📄 05 - How to edit an order’s information - [Step-by-Step guide], using the carrier-specific values provided in this guide.

When editing an Order, use Service code in the Service section to select Default when service selection is left to the order.

Click Save to apply the order-level changes. After the Order is updated, continue with the standard shipping workflow.

Troubleshooting

• Subclient rates or shipments are rejected: Check Sub-client ID in the Client Account's Carrier tab against the identifier provided by Obibox. Confirm the Baseline Account's API key belongs to the parent organization and uses the intended test or production environment.

• Shipment uses an unexpected pickup address: Check whether Sub-client ID is populated. If it is, review the sub client's default pickup address with Obibox; the pickup identifiers in techSHIP do not override it. If it is blank, review Pickup Address ID override on the Client Account first, then Pickup Address ID on the Baseline Account.

• Pickup identifier is rejected: When shipping without a subclient, use the pickup-address UUID supplied by Obibox, rather than a numeric address identifier.

• Rating fails on sender or recipient data: Check that both addresses contain a city, province, postal code, and country, and that the shipment is Canadian domestic. These address requirements still apply when using a subclient.

• Shipment processing fails on recipient or package data: Provide a recipient name or company, street address, and Canadian or US phone number. Correct any invalid recipient email address and confirm the order contains 1–20 packages.

• Selected rate cannot be used: Retrieve rates again if the quote has expired, belongs to a different Client Account, or cannot be identified unambiguously. Use the new rate for the intended account.

• PDF label is still pending: If retrieval reports that the label is not ready after the two-minute polling window, retry label retrieval for the existing shipment. If the carrier response specifies a waiting period, wait that long before retrying.