docs.uniuni.com Open in urlscan Pro
54.205.206.47  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Public


Documentation Settings

ENVIRONMENT
Sandbox

LAYOUT
Double Column

LANGUAGE
cURL - cURL



UniUni Integration API Documentation
Introduction
Authorization
Rates and Sorting Information API
Batch API
Ship API
Service Availability API
Track API


UNIUNI INTEGRATION API DOCUMENTATION

Welcome to the UniUni API documentation. This document will guide you through
the steps of integrating with our platform using our APIs. You can use our APIs
to access various features and services offered by UniUni.


ENVIRONMENT

We have a Sandbox environment where you can test our APIs for Canada- and
USA-based clients. The Sandbox allows you to check the API URLs, view the API
parameters, test the API requests and view the API responses.

Canada Environment

   

 * Sandbox QA URL: https://bizqa.uniexpress.org

   

 * QA API URL: https://sjqa.uniexpress.org

   

 * The production API URL: https://sj.uniexpress.ca

   

USA Environment

   

 * Sandbox QA URL: https://prm.qa.uniuni.com

   

 * QA API URL: https://prm-api.qa.uniuni.com

   

 * Production API URL: https://prm-api.uniuni.com

   

Please note, API examples in the document use the Canadian QA URL:
https://sjqa.uniexpress.org


SYSTEM MAINTENANCE NOTICE

To ensure the stability and performance of the system, UniUni will conduct
regular system maintenance every Sunday from 00:30 to 02:00 AM (Pacific Time
Zone, Los Angeles, Vancouver). During this maintenance window, all API services
will be temporarily unavailable. We advise our customers to avoid making API
calls during this period to prevent any disruption to your operations.

We recommend scheduling your activities accordingly to avoid any inconvenience.
Thank you for your understanding and cooperation.


API CALL SEQUENCE

The following flowchart describes the call sequence between the main APIs




FAQ


WHAT IS THE DIFFERENCE BETWEEN A CLIENT AND A CUSTOMER IN UNIUNI'S SYSTEM?

In UniUni’s operational context, the terms 'client' and 'customer' have distinct
definitions and roles:

   

 * Client: This term refers to a business partner who has entered into a formal
   agreement with UniUni, which includes specific terms regarding pricing and
   service delivery. Clients typically have long-term strategic relationships
   with our company.

   

 * Customer: This designation is used for organizations that interact directly
   with UniUni's logistics services, either by utilizing our package pickup
   service at their physical locations or by dropping off packages at our
   warehouse facilities.

   

Account Management Scenarios:

   

 * Multiple Pickup Locations: When generating an order for multiple package
   pickup locations, specify each location using the pick_address parameter.

   

 * Distinct Billing Requirements: If separate billing is needed for different
   organisations, UniUni will establish individual customer accounts for each
   organisation to accommodate this need.

   

 * Unique Pricing Agreements: If there is a specific organisation with a unique
   pricing agreement, both a new client account and a customer account will be
   created to reflect the bespoke terms of that agreement.

   

These distinctions help streamline our services and ensure that both strategic
business relationships and operational needs are effectively managed.


CAN I USE THE SHIPPING LABEL GENERATED BY MY SYSTEM?

Yes, customers located in Canada are permitted to use their own shipping labels.
To ensure compliance with our delivery process and to facilitate efficient
handling at our facilities, please adhere to the following guidelines:

   

 * Sorting Information Placement:
   
     
   * Print the sorting information of UniUni on the top right corner of your
     label to assist our operating team in manually sorting the boxes upon
     arrival.
     
   

 * Logo Placement:
   
     
   * Include the UniUni logo on the top left corner of the label to clearly
     identify the shipment as being processed through our network.
     
   

 * Box Specifications:
   
     
   * Refrain from using oversized or overly heavy boxes that may not be
     compatible with our conveyor systems. For specific box requirements or to
     discuss suitable packaging options, please contact the UniUni Business
     Development Team.
     
   

Your cooperation in following these guidelines ensures a seamless sorting and
delivery process at our warehouse. Thank you.


WHAT OPTIONS ARE AVAILABLE TO TRACK A PACKAGE FROM UNIUNI?

To monitor the status of your package, UniUni offers the following tracking
methods:

   

 * Official Website Tracking:
   
     
   * Access the UniUni official website and input your tracking number in the
     tracking section to view the current status of your shipment.
     
   

 * Tracking API:
   
     
   * Employ the Tracking API or Webhook to programmatically retrieve tracking
     events. This method is ideal for integrating shipment tracking into your
     system or application.
     
   

 * Direct Tracking URL:
   
     
   
   * Utilize the following URL format to directly track your package:
     https://www.uniuni.com/tracking/?no=TRACKING_NUMBER. Replace
     TRACKING_NUMBER with the unique number assigned to your package.
   
     
   
   * Example URL: https://www.uniuni.com/tracking/?no=UUS0450316625854.
   
     
   

These options provide flexibility for tracking your shipments according to your
preference, whether manually via our website or programmatically through our
API.


HOW TO CREATE SHIPMENT IF I DON’T HAVE THE MAWB AND BAG NUMBER?

If you are an overseas partner requiring UniUni's pick-up services from a custom
clearance company, it is standard to provide the MAWB (Master Air Waybill) and
bag numbers to facilitate batch tracking of shipments. However, if these details
are unavailable at the time of shipment creation, you may proceed as follows:

   

 * Initial Shipment Creation:
   
     
   * Invoke the POST /createbusinessorder (API 2.4.1) endpoint with reference
     and bag_no parameters set to null.
     
   

 * Batch Creation Upon Receiving MAWB:
   
     
   * Utilize POST /createbatch (API 2.3.1) once the MAWB is available.
     
   

 * Updating Bag Number:
   
     
   * Call the POST /updatebagno endpoint (API 2.8.1) to update the bag number
     associated with your shipment.
     
   

 * Updating Batch Number:
   
     
   * Use POST /updateorderbatch (API 2.8.2) to update the batch number for your
     shipments.
     
   

Please note that the shipment can be created without the reference details and
updated subsequently when these details become available.


HOW DO YOU DETERMINE THE ACTUAL PRICE OF A SHIPMENT?

The pricing of shipments is calculated through a dedicated billing system which
operates on a weekly cycle. Here's an overview of the process:

   

 * Billing Cycle Initiation:
   
     
   * Every Monday, the system reviews all orders eligible for billing.
     
   

 * Calculation of Orders:
   
     
   * The actual price is computed based on the dimensional weight of the
     shipments received at our warehouse facilities during the previous week, in
     conjunction with the pre-agreed prices.
     
   

 * Dimensional Weight and Price Determination:
   
     
   * Dimensions and weight data utilized in billing are sourced from the API
     messages sent by the client.
     
   

 * Verification of API Data:
   
     
   * To ensure the accuracy of the data received via API, our quality control
     team conducts random checks where they manually measure and weigh selected
     packages to validate the API-reported values.
     
   

This method ensures that billing is accurate and reflects the true cost of
shipments based on agreed terms and actual shipment data.


APPENDIX


AVAILABLE TRACKING EVENTS & EXPLANATIONS

Please note that the availablity of tracking events in the US and Canada are
various. Records with '*' are not provided to the US market.

View More

Code State Description Explanation Next State Code 190 ORDER_RECEIVED Order
received Shipment generated in UniUni’s system 198
199
207
221 192 CUSTOM_HOLD Your parcel has been presented to Canada Border for Customs
review 198
199 195 GATEWAY_TRANSIT_OUT Gateway transit out The shipment has left UniUni's
hub warehouse and is in transit to UniUni’s last-mile dispatch facility. 200
218
219 198 CUSTOM_RELEASE_DIRECT Your parcel has been released by Canada Customs
195
199
200
209
219
221 199 GATEWAY_TRANSIT Gateway transit in The shipment has arrived at UniUni's
hub warehouse and is waiting to be transferred to the local warehouse. 195
200
218
219
255 200 PARCEL_SCANNED Arrival scan The shipment arrived at UniUni’s last-mile
dispatch facility 201
202
204
212
215
218
219
223
224
225
230 202 IN_TRANSIT Out for delivery The shipment is out for delivery 200
203
206
211
218
219
222
231 203 DELIVERED Delivered The shipment was delivered to the recipient End
Point 204* TRANSSHIPMENT Transshipment through third party In some cases, the
partner may send a package to UniUni that is out of UniUni's FSA and requires a
transshipment by a third-party cour 215
217
218 206 WRONG_ADDRESS_FROM_TRANSIT Fail to deliver, invalid address 202
203
211
213
218 207 PARCEL_LOST Parcel lost End Point 209 OTHER_EXCEPTION Other exception
200 211 RETURN_OFFICE_FROM_TRANSIT Failed delivery attempt, returning to the
warehouse The delivery attempt failed. The package will be returned to UniUni’s
last-mile dispatch facility 202
203
206
213
218
222
226
229 212 WRONG_ADDRESS_FROM_RECEIVE Invalid address in arrival scan 213 213
STORAGE_30_DAYS_FROM_OFFICE Parcel returned to warehouse The shipment cannot be
delivered to the receiver after the second attempt and is returned to UniUni’s
last-mile dispatch facility. 204
215
216
220
223
230 214 STORAGE_30_DAYS_AFTER_SCAN Parcel is ready for pickup 216
223 215 PARCEL_ABANDONED Parcel return to sender The shipment has been abandoned
or returned to the sender because it cannot be delivered and has been in the
warehouse for more than 30 days. End Point 216 SELF_PICK_UP Customer pickup The
receiver has already picked up the shipment from UniUni’s last-mile dispatch
facility. End Point 217* TRANSSHIPMENT_COMPLETE Transshipment completed UniUni
has handed over the package to the third-party courier. End Point 218
SCANNED_PARCEL_MISSING Scanned parcel processing delay 202
207
215 219 WRONG_ROUTE_PARCEL Wrong routing 199
200
200
218 220 SECOND_DELIVERY Delivery is rescheduled 203
213
215
216
228
230 221 RETURNED_PARCEL_SCANNED Returned parcel scanned 202
204
212
213
214
216
223 222 REJECTED_PARCEL_FROM_TRANSIT Delivered parcel rejected by customer 213
218 223* CHANGED_ORDER_RESENT New order created for redelivery 203
215 224* RESENT_ORDER_VOIDED Redelivery Order voided due to customer pickup or
other reason End Point 225* FORWARDED_3RDPARTY Parcel forwarded to third party
200 226 STORAGE_3RDPARTY_SERVICE_POINT Parcel is ready for pickup at service
point 213 228 SECOND_DELIVERED Redelivered The shipment has been successfully
delivered. The input code of 228 is 220. End Point 229 DROP_OFF_SERVICE_POINTS
Dropped off at service point, available for pickup next day 226 230 RETURN TO
SENDER WAREHOUSE Return to sender warehouse The shipment was returned to the
sender’s warehouse End Point 231 FAILED_DELIVERY_RETRY1 Failed delivery, retry
later The 1st delivery attempt failed. The driver will retry later. 203
211
232 232* FAILED_DELIVERY_RETRY2 Failed delivery, retry later The 2nd delivery
attempt failed. The driver will retry later(If the next attempt failed again,
the package will be sent back to the warehouse with code 211). 203
211 255* Gateway_To_Gateway_Transit Gateway to gateway transit 199


UNIUNI HUB WAREHOUSE LOCATION IN CANADA

Please contact UniUni Business Development team for the most up-to-date
warehouse address.

View More

id name airport 1 Burnaby Warehouse YVR 2 Toronto Warehouse YYZ 3 Edmonton
Warehouse YEG 4 Calgary Warehouse YYC 5 Montreal Warehouse YUL 7 Ottawa
Warehouse YOW 16 Winnipeg Warehouse YWG 17 Halifax Warehouse YHZ 19 Quebec City
Warehouse YQB 21 Regina Warehouse YQR 23 Moncton Warehouse YQM 24 St John’s
Warehouse YYT 25 Saskatoon Warehouse YXE


UNIUNI HUB WAREHOUSE LOCATION IN THE US

Please contact UniUni Business Development team for the most up-to-date
warehouse address.

View More

id name airport 1 LAX Warehouse LAX 2 MIA Warehouse MIA 3 Chicago warehouse ORD
4 Dallas Warehouse DFW 12 Bay Area SJC 16 PHX Warehouse PHX 17 JFK Warehouse JFK
18 NJ Warehouse EWR 19 IAH Warehouse IAH 20 LAS Warehouse LAS 21 AUS Warehouse
AUS 22 SAT Warehouse SAT 23 IND Warehouse IND 24 SMF Warehouse SMF 25 PHL
Warehouse PHL 26 DCA Warehouse DCA 27 SEA Warehouse SEA 29 MCO Warehouse MCO 30
PDX Warehouse PDX 31 ATL Warehouse ATL 32 RNO Warehouse RNO 33 CVG Warehouse CVG
34 CLT Warehouse CLT 35 RDU Warehouse RDU 36 MSP Warehouse MSP 37 JAX Warehouse
JAX 38 TPA Warehouse TPA 39 BOS Warehouse BOS

AUTHORIZATIONBearer Token
Token

<token>