The Track and Trace API gives the client the possibility to get information about a current shipment based on the shipments barcode information. The API is based on a WCF Service with a RESTFUL implementation.
Following is a description of the API and its functionalities.
For access of the Track and Trace API please call the following web address:
http://ubapimanagement.azure-api.net/trackandtrace
For easy testing, an extension like the Postman extension for the Chrome Browser can be used.
Gets tracking information about the shipment
The track and trace API is design in the way that the specific carrier defined in the carrier field is contacted firstly for track and trace information. If this fails, the API continues to contact Consignor (Booking System Provider) if used in the setup to retrieve information here. If this also fails, United Broker own systems are contacted to retrieve the track and trace info. This way we always make sure that information is available.
http://ubapimanagement.azure-api.net/trackandtrace/TrackAwb
GET
http://ubapimanagement.azure-api.net/trackandtrace/TrackAwb?Identification=00370720684126597722
| Name | Type | Required | Description |
|---|---|---|---|
| Identification | string |
The barcode (Shipment AWB), order number or reference of the shipment. | |
| LangCode | string |
Two letter ISO language code. Works with limited range of products and languages. |
If request was successful, system will return json response with information about the shipment.
InformationSource field shows which provider was contacted for retrieving the information. By this you can provide information to the end user on where you have the information from, as the richness of information differs from source system to system.
You will receive a status code 200 in the StatusCode field if the request went well, else you will receive an error code in this field, and a list of error messages in the ErrorMessages field.
{
"StatusCode": 404,
"ErrorMessages": [
"Booking not found"
]
}
{
"StatusCode": 200,
"SuccessObject": [
{
"InformationSource": "PostNord",
"LangCode": "en",
"TrackingUrl": "https://tracking.postnord.com/dk/?id=3d66cdc4:0037:cf82:0720:1e78:8571:536c0013fc18:684126597722",
"Package": {
"CarrierId": 9,
"CarrierName": "PostNord",
"SubCarrierId": 20,
"SubCarrierName": "Indland",
"Weight": 9999,
"CarrierWeight": 0,
"ProductName": "Return",
"PickupDateObject": "/Date(1505260800000)/",
"PickupDateString": "2017-09-13T00:00:00.00",
"ShipmentAwb": "00370720684126597722",
"OrderNumber": "10330168",
"CustomerReference": "",
"SenderReference": "(10330168) "
},
"Scans": [
{
"DateObject": "/Date(1505208926290)/",
"DateString": "2017-09-12T09:35:26.29",
"Location": "0",
"Code": "1",
"Text": "Information Received At UnitedBroker"
}
],
"Receiver": {
"BusinessName": "Pernille Kvorning",
"ContactName": "",
"Address": "Edv.Egebergs Vej 27 ",
"Zip": "8600",
"City": "Silkeborg",
"Country": "Denmark"
},
"PUDO": {
"Address": " ",
"Zip": "",
"City": "",
"Country": "Denmark"
},
"Signature": {
"Name": null,
"Image": null,
"Link": null,
"Type": "N/A"
},
"CarrierLogoGroup": 3,
"IsError": false,
"ErrorReason": null,
"ResponseCode": 200
}
]
}
Gets list of shipments
This endpoint will return a list of shipments based on a sinle search key. It has a pagination for a large number of results.
http://ubapimanagement.azure-api.net/trackandtrace/GetSearchResultList
GET
http://ubapimanagement.azure-api.net/trackandtrace/GetSearchResultList?identification=20&pageNumber=0&pageSize=25
http://ubapimanagement.azure-api.net/trackandtrace/GetSearchResultList?identification=20
| Name | Type | Required | Description |
|---|---|---|---|
| Identification | string |
The barcode (Shipment AWB), order number or reference of the shipment. | |
| PageNumber | int |
Page number starts from 0.
Works only if PageSize is provided.
|
|
| PageSize | int |
Default value is 25.
Works only if PageNumber is provided.
|
If request was successful, system will return json response with a short information about the shipments.
SubCarrierId value can be used in /TrackSpecificAwb call.
{
"StatusCode": 200,
"SuccessObject": {
"Results": [],
"TotalCount": 0
}
}
{
"StatusCode": 200,
"SuccessObject": {
"Results": [
{
"Ordernumber": "100186983",
"ShipmentAwb": "338950796766",
"ReceiversReference": "456",
"ReceiversReference2": "",
"SendersReference": "456",
"SubCarrierId": "507",
"ReqestedPickUpTime": "/Date(1559260800000)/"
},
{
"Ordernumber": "100168010",
"ShipmentAwb": "338950681024",
"ReceiversReference": "456",
"ReceiversReference2": "",
"SendersReference": "456",
"SubCarrierId": "507",
"ReqestedPickUpTime": "/Date(1556668800000)/"
},
{
"Ordernumber": "100106400",
"ShipmentAwb": "618991054101",
"ReceiversReference": "",
"ReceiversReference2": "",
"SendersReference": "456",
"SubCarrierId": "507",
"ReqestedPickUpTime": "/Date(1546992000000)/"
},
{
"Ordernumber": "10430265",
"ShipmentAwb": "338948998240",
"ReceiversReference": "",
"ReceiversReference2": "",
"SendersReference": "456",
"SubCarrierId": "507",
"ReqestedPickUpTime": "/Date(1517443200000)/"
},
{
"Ordernumber": "456",
"ShipmentAwb": "012028111118",
"ReceiversReference": "",
"ReceiversReference2": "",
"SendersReference": "Shipped with UBsend.com",
"SubCarrierId": "23",
"ReqestedPickUpTime": "/Date(1514934000000)/"
},
{
"Ordernumber": "10367003",
"ShipmentAwb": "338946248569",
"ReceiversReference": "",
"ReceiversReference2": "",
"SendersReference": "456",
"SubCarrierId": "507",
"ReqestedPickUpTime": "/Date(1510012800000)/"
},
{
"Ordernumber": "10339734",
"ShipmentAwb": "338946156161",
"ReceiversReference": "",
"ReceiversReference2": "",
"SendersReference": "456",
"SubCarrierId": "507",
"ReqestedPickUpTime": "/Date(1506384000000)/"
},
{
"Ordernumber": "",
"ShipmentAwb": "00370720683765274773",
"ReceiversReference": "",
"ReceiversReference2": "",
"SendersReference": "456",
"SubCarrierId": "20",
"ReqestedPickUpTime": "/Date(1490745600000)/"
},
{
"Ordernumber": "",
"ShipmentAwb": "00370720683765249481",
"ReceiversReference": "",
"ReceiversReference2": "",
"SendersReference": "456",
"SubCarrierId": "20",
"ReqestedPickUpTime": "/Date(1487721600000)/"
},
{
"Ordernumber": "10183522",
"ShipmentAwb": "338945414866",
"ReceiversReference": "",
"ReceiversReference2": "",
"SendersReference": "456",
"SubCarrierId": "507",
"ReqestedPickUpTime": "/Date(1485302400000)/"
},
{
"Ordernumber": "",
"ShipmentAwb": "00370720683765183099",
"ReceiversReference": "",
"ReceiversReference2": "",
"SendersReference": "456",
"SubCarrierId": "20",
"ReqestedPickUpTime": "/Date(1481068800000)/"
},
{
"Ordernumber": "10148752",
"ShipmentAwb": "618973725906",
"ReceiversReference": "",
"ReceiversReference2": "",
"SendersReference": "456",
"SubCarrierId": "507",
"ReqestedPickUpTime": "/Date(1480464000000)/"
}
],
"TotalCount": 12
}
}
Gets a single shipment with tracking events
This endpoint will return a single shipment based on a tracking barcode (ShipmentAwb) and SubCarrierId.
http://ubapimanagement.azure-api.net/trackandtrace/TrackSpecificAwb
GET
http://ubapimanagement.azure-api.net/trackandtrace/TrackSpecificAwb?Identification=338949276606&SubCarrierId=507&LangCode=en
| Name | Type | Required | Description |
|---|---|---|---|
| Identification | string |
The barcode (Shipment AWB). | |
| SubCarrierId | long |
Value can be taken from /GetSearchResultList response.
|
|
| LangCode | string |
Two letter ISO language code. Works with limited range of products and languages. |
If request was successful, system will return json response with information about the shipment.
InformationSource field shows which provider was contacted for retrieving the information. By this you can provide information to the end user on where you have the information from, as the richness of information differs from source system to system.
{"StatusCode":404,"ErrorMessages":["Language not found"]}
{
"StatusCode": 200,
"SuccessObject": [
{
"InformationSource": "UB",
"LangCode": "en",
"TrackingUrl": "http://www.gls-group.eu/276-I-PORTAL-WEB/dLink.jsp?un=2760305426&key=D205A1F74EE11C396CCE099C33B5034A&rf=&crf=338949276606&no=2760305426&lc=EN",
"IsTrackingUrlUbGenerated": false,
"Package": {
"CarrierId": 257,
"CarrierName": "GLS Germany",
"SubCarrierId": 507,
"SubCarrierName": "Domestic",
"Weight": 19999,
"CarrierWeight": 0,
"ProductName": "Pick and Ship",
"PickupDateObject": "/Date(1526169600000)/",
"PickupDateString": "2018-05-13T00:00:00.00",
"ShipmentAwb": "338949276606",
"OrderNumber": "10491534",
"CustomerReference": "N/A",
"SenderReference": "9"
},
"Scans": [
{
"DateObject": "/Date(1526296020000)/",
"DateString": "2018-05-14T11:07:00.00",
"Location": "0",
"Code": "2953",
"Text": "No Parcel to pickup"
},
{
"DateObject": "/Date(1526273940000)/",
"DateString": "2018-05-14T04:59:00.00",
"Location": "0",
"Code": "2902",
"Text": "Label printed"
},
{
"DateObject": "/Date(1526070169000)/",
"DateString": "2018-05-11T20:22:49.00",
"Location": "0",
"Code": "0",
"Text": "Information Received At UnitedBroker"
},
{
"DateObject": "/Date(1526070091640)/",
"DateString": "2018-05-11T20:21:31.64",
"Location": "0",
"Code": "",
"Text": "Transmitted"
}
],
"Receiver": {
"BusinessName": "Best company",
"ContactName": "",
"Address": "Perfect location",
"Zip": "53111",
"City": "Bonn",
"Country": "Germany"
},
"PUDO": {
"Address": " ",
"Zip": "",
"City": "",
"Country": "Germany"
},
"Signature": {
"Name": null,
"Image": null,
"Link": null,
"Type": "N/A"
},
"CarrierLogoGroup": 0,
"IsError": false,
"ErrorReason": null,
"ResponseCode": 0
}
]
}
Adds tracking information to the shipment
This method allows external providers to use API setup to add scan information to the shipments
http://ubapimanagement.azure-api.net/trackandtrace/PostTrackAndTrace
POST
Content-Type: application/json
Authorization: Basic base64(username:password)
{
"ShipmentAwb": "127408975",
"ScanDate": "2019-05-04T06:24:47",
"ScanServerTime": "2019-05-04T05:24:47",
"ScanLocation": 0,
"GpsLatitude": "",
"GpsLongitude": "",
"ScanSignature": "",
"ScanText": "Delivered",
"ScanCode": "D1",
"BookingSystemStatus": "",
"Origin": "DHL",
"CarrierWeight": 5000.0,
"CarrierLength": 100.0,
"CarrierWidth": 100.0,
"CarrierHeight": 100.0,
"SubCarrierID": 1000000009
}
| Name | Type | Required | Description |
|---|---|---|---|
| ShipmentAwb | string |
Tracking identifier of the parcel | |
| ScanDate | string |
Date and time of an event | |
| ScanServerTime | string |
Server date and time of an event | |
| ScanLocation | int |
Location identifier of an event | |
| GpsLatitude | string |
GPS Latitude of an event | |
| GpsLongitude | string |
GPS Longtitude of an event | |
| ScanSignature | string |
Base64 code of customer's signature of an event | |
| ScanText | string |
Event description text | |
| ScanCode | string |
Event code | |
| Origin | string |
Identifier of an event provider - provided by UB | |
| CarrierWeight | double |
Weight of parcel measured by carrier | |
| CarrierLength | double |
Length of parcel measured by carrier | |
| CarrierWidth | double |
Width of parcel measured by carrier | |
| CarrierHeight | double |
Height of parcel measured by carrier | |
| SubCarrierID | long |
SubCarrier ID taken from the subcarrier list |
If request was successful, system will return json repsonse with information about processing the request.
You will receive a status code 200 in the StatusCode field if the request went well, else you will receive an error code in this field, and a list of error messages in the ErrorMessages field.
{
"StatusCode": 200,
"SuccessObject": "ScanLine added successfully"
}
{
"StatusCode": 500,
"ErrorMessages": [
"Internal server error"
]
}
Copyright © UBsend 2025. All rights reserved.