Obibox v2 Onboarding Requirements and Configuration Guides [Information]

Modified on Thu, 27 Aug at 6:38 AM

Article 1: Obibox Onboarding Requirements and Configuration Guides [Information]Article 2: Reference Data: Obibox Baseline Account Fields [Guide]Article 3: Reference Data: Obibox Client (Billing) Account Fields [Guide]Article 4: Reference Data: Order-Level Obibox Fields [Guide]
Onboarding and ConfigurationBaseline Account(Billing) AccountOrder-Level Fields
You are hereYou are here         

   

This article is the central hub for adding Obibox with techSHIP. It summarizes onboarding requirements, links the related configuration guides, and lists confirmed carrier-specific constraints.

   

   
   

  

To review all supported carriers and their specific requirements, see: techSHIP supported Carriers - Master List [Guides List].

   

   

   

TABLE OF CONTENTS


Onboarding Requirements


Before configuring Obibox in techSHIP, gather the required credentials and verify the required account settings


Information to be Provided


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

     

DATA ELEMENTSOURCE (HOW TO OBTAIN)
API keyObibox API key provided for the applicable environment. Use an sk_test_ key for test mode or an sk_live_ key for production mode.
Sender addressConfirmed ship-from address used by Obibox for pickup and shipment processing.
Pickup Address ID
Pickup address identifier when provided for the Obibox account or shipment configuration.

   

Settings to be Verified


The following account configurations must be validated to prevent errors during the connection setup or the shipping process:

   

FEATURE/SETTINGVALIDATION ACTION
API authenticationConfirm the Obibox API key authenticates successfully and the Baseline Account can be saved.
Pickup addressConfirm the sender address is supported for Obibox pickup and shipment processing.
Recipient phoneConfirm recipient phone values are provided as supported Canadian or US phone numbers so they can be sent to the carrier in +1 format.
Ship-to addressConfirm the ship-to city, province, postal code, and country before processing shipments.

   



Obibox shipments are supported for Canada. Review the sender address and destination details before processing shipments.

 
   

   

Setup Articles


Use the setup articles below to complete the set up in order. Start with onboarding requirements, then configure the Baseline Account, Client (Billing) Account, and optionally, Order-level settings. Select an article number to open the corresponding guide:

   

   Article 1: Obibox Onboarding Requirements and Configuration Guides [Information]Article 2: Reference Data: Obibox Baseline Account Fields [Guide]Article 3: Reference Data: Obibox Client (Billing) Account Fields [Guide]Article 4: Reference Data: Order-Level Obibox Fields [Guide]
COMPONENT
ONBOARDING REQUIREMENTS
BASELINE ACCOUNT
(BILLING) ACCOUNT 
ORDER-LEVEL FIELDS
Mandatory
Mandatory
Mandatory
Mandatory
   
Scope
Requirements
Carrier
Client
Transaction
Description
Identifies the required onboarding information and organizes the related setup guides for this carrier.
Establishes the carrier connection. Must be created first.
Connects a specific client to the Baseline. At least one is required to ship.
Defines order-level fields and settings used when processing shipments for this carrier.

    

Carrier Specifications and Constraints


This section outlines confirmed operational behaviors, document support, label support, and limitations specific to this carrier. 


Labels


The following table summarizes confirmed document and label support:

    

ITEMSUPPORTED
LabelPDF

   

Operational Details


This section lists confirmed operational rules and limitations for this carrier. Include only constraints that have been validated for this carrier:

  • Obibox supports domestic small parcel shipments.
  • Test mode is supported when using test credentials.
  • Rates and rate shopping are supported.
  • Tracking history is supported.
  • The confirmed shipment workflow uses rate retrieval, order creation, order retrieval, and label retrieval.
  • Recipient phone values are normalized before they are sent to the carrier. Supported Canadian and US phone values are sent in +1 format.
  • Recipient phone extensions are not sent to the carrier.
  • Ship-to postal codes are trimmed before they are sent to the carrier.
  • Package weight and dimension limits are enforced by the carrier.
  • Quote expiry is enforced by the carrier.
  • Void functionality is not available in techSHIP for Obibox. Cancellations must be handled from the Obibox portal.


Next Steps


After reviewing the onboarding requirements, continue with the Reference Data: Obibox Baseline Account Fields [Guide] article to configure the carrier connection in techSHIP.

   

   Go to Go to       
Article 1: Obibox Onboarding Requirements and Configuration Guides [Information]Article 2: Reference Data: Obibox Baseline Account Fields [Guide]Article 3: Reference Data: Obibox Client (Billing) Account Fields [Guide]Article 4: Reference Data: Order-Level Obibox Fields [Guide]
Onboarding and ConfigurationBaseline Account(Billing) AccountOrder-Level Fields

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article