Get Shipment Tracking Events

This API describes how to get a shipment tracking events.

Method: POST

Request Body

json

{
  "tracking_no": ["24032007363306SG", "24032614935479SG"]
}

Request Body Explanation

Attribute Name	Type	Description
tracking_no	List	List of tracking numbers

Response Body

json

{
  "code": 200,
  "data": [
    {
      "tracking_no": "24032007363306SG",
      "summary": {
        "datetime": "2023-08-29 23:32:46",
        "time_zone": "America/New_York",
        "description": "",
        "location": "",
        "facility_add": null,
        "city": null,
        "state": null,
        "postcode": null,
        "country": "",
        "event_id": "10",
        "event_desc": "Label Created",
        "sub_event_id": "10",
        "sub_event_desc": "Shipment Label Created"
      },
      "details": [
        {
          "datetime": "2023-08-29 23:32:46",
          "time_zone": "America/New_York",
          "description": "",
          "location": "",
          "facility_add": null,
          "city": null,
          "state": null,
          "postcode": null,
          "country": "",
          "event_id": "10",
          "event_desc": "Label Created",
          "sub_event_id": "10",
          "sub_event_desc": "Shipment Label Created"
        }
      ]
    },
    {
      "tracking_no": "24032614935479SG",
      "summary": {
        "datetime": "2023-08-29 23:32:46",
        "time_zone": "America/New_York",
        "description": "",
        "location": "",
        "facility_add": null,
        "city": null,
        "state": null,
        "postcode": null,
        "country": "",
        "event_id": "10",
        "event_desc": "Label Created",
        "sub_event_id": "10",
        "sub_event_desc": "Shipment Label Created"
      },
      "details": [
        {
          "datetime": "2023-08-29 23:32:46",
          "time_zone": "America/New_York",
          "description": "",
          "location": "",
          "facility_add": null,
          "city": null,
          "state": null,
          "postcode": null,
          "country": "",
          "event_id": "10",
          "event_desc": "Label Created",
          "sub_event_id": "10",
          "sub_event_desc": "Shipment Label Created"
        }
      ]
    }
  ]
}

Response Body Explanation

Attribute Name	Type	Description
code	Integer	Response code: 200 successful, 400/500 failed
data	List	return value list of orders' tracking details
summary	Object	the latest tracking event
details	List	all the detailed tracking events and sub events
tracking_no	String	tracking number
datetime	String	date and time of the event
time_zone	String	time zone of the event
description	String	notes of the event
location	String	location of the event
facility_add	String	the name of facility which added this event
city	String	city where this event occurred
state	String	state where this event occurred
postcode	String	postal code of the area where this event occurred
country	String	country where this event occurred
event_id	String	event identification number
event_desc	String	short description of the event
sub_event_id	String	sub event identification number
sub_event_desc	String	short description of the sub event

Tracking Event Reference

event_id	status_id	description
10	10	Shipment Label Created
15	50	Shipment Manifest Transmitted to origin GPS/Partner Facility
20	50	Carrier Notified to Pick Up Package
30	50	Picked up by Shipping Partner
40	50	On its way to Origin Facility
90	50	Received from prior carrier
95	50	Rejected at Processing Facility - Parcel Cancelled
96	50	Parcel previously checked in
100	100	Accepted at Processing Facility
101	100	Package Weight Updated
102	100	Package Dimension Updated
103	100	Package Chargeeable Weight Updated
105	100	Package Total Service Cost Updated
106	100	Accepted at Processing Facility - Label Replaced
110	100	Overpack-Bag/Pallet
115	100	Shipment Manifest transmitted to Air/Ocean carrier
120	100	Departed Origin Facility
125	100	Origin Handoff
130	100	Departed Origin Country
150	100	In Transit to Destination Country
200	100	Arrived Destination Country
210	100	Arrived Destination Facility
220	100	Unload from Bag/pallet
231	100	Shipment information received
232	100	Shipment inventory allocated
233	100	Shipment Processed
234	100	Shipment UnProcessed
235	100	Shipment Fulfilled
236	100	Crossing Border
237	100	Crossing Received
239	100	Shipment information transmitted to carrier
240	100	Shipment information received by carrier
245	100	Shipment on Hold
251	100	Item Scanned
252	100	Item Scanned - GPS/Partner Facility - Inbound
253	100	Item Scanned - GPS/Partner Facility - Outbound
254	100	Item Scanned - Postal Facility
255	100	Item Scanned - Facility
256	100	Item Scanned - Crossing
280	100	Sorting Scan
281	100	Departure Scan
282	100	Arrival Scan
290	700	Package with no information scanned
300	300	Pre-Clearance Information Received
301	300	Received for Pre-Clearance
330	300	Brokearge Review Process Initiated
331	330	Brokerage Hold-Permit required
332	330	Brokerage Hold-Formal Entry
333	330	Brokerage Hold-Underclared
334	330	Brokerage Hold-Bad description
335	330	Brokerage Hold-Incomplete shipment information
336	330	Brokerage Hold-Country of Origin required
337	330	Brokerage Hold-POA required
338	330	Brokerage Hold- Overage Shipment
339	330	Brokerage Hold- 3rd Party broker required
340	330	Brokerage Hold-HS Code required
341	330	Brokerage Hold-Prohibited item
342	330	Brokerage Hold-Restricted item
343	330	Brokerage Hold-Tax ID required
344	330	Brokerage Hold-Other
359	300	Brokerage Review Completed
360	360	Custom Information Transmitted
361	360	Custom Clearance Process Initiated
362	362	Customs Inspection
363	362	Customs Hold-Permit required
364	362	Customs Hold-Formal Entry
365	362	Customs Hold-Underclared
366	362	Customs Hold-Bad description
367	362	Customs Hold-Incomplete shipment information
368	362	Customs Hold-Country of Origin required
369	362	Customs Hold-POA required
370	362	Customs Hold-HS Code required
371	362	Customs Hold-Prohibited item
372	362	Customs Hold-Restricted item
373	362	Customs Hold-Tax ID required
374	362	Customs Hold-Duty/tax payment required
375	362	Customs Hold-Import Restricted
376	362	Customs Issue
377	390	Seized by Customs
378	362	Customs Hold-Other
379	362	Customs Clearance Delayed
380	360	Customs Verified
389	389	Customs Release
390	390	Seized by Official Government Authority
415	100	Shipment Manifest Transmitted to Regional Carrier
416	100	Shipment Manifest Transmitted to Last Mile Carrier
420	100	On its way to GPS/Partner Facility
421	100	Tendered to GPS/Partner Facility
440	100	On its way to Local Post Office
441	100	Tendered to Local Post Office
442	100	Tendered to Local Post Office (No POD)
443	100	Customer dropped off at postal facility
450	100	Tendered to Last Mile Carrier
451	100	Tendered to Last Mile Carrier (No POD)
460	460	Held by Carrier
461	460	Held by Carrier - Payment
462	460	Held by carrier - Seller Input Required
463	460	Held by GPS/Partner Facility - Insufficient Balance, Pending Payment
464	460	Held by carrier - Tax ID
465	460	Held by carrier - Incorrect Address
466	460	Held by carrier - Incomplete Address
480	100	Item Processed by Carrier
481	100	Repacked
490	100	Parcel intercept requested
495	100	Redirected to new address
600	100	Self pickup requested/required by consignee
601	100	On its way to pickup location
602	100	Arrived at pick up location
603	100	Available for pickup
609	460	No space at pickup location
610	100	Consignee contacted to arrange delivery/pickup
611	100	Delivery/Pickup appointment scheduled
612	100	Delivery/Pickup appointment re-scheduled
620	100	Out for Delivery
621	100	Delivery Attempted
622	100	1st Delivery Attempt
623	100	2nd Delivery Attempt
624	100	Other Delivery Attempt
625	100	Final Delivery Attempt
626	100	1st Delivery Attempt Failed
627	100	2nd Delivery Attempt Failed
628	460	Other Delivery Attempt Failed
629	460	Final Delivery Attempt Failed
650	100	Return Pending
651	100	Return Received
652	100	Return Inspection
653	100	Return Finalized
660	100	Claims Issued
661	700	Claims Rejected
701	700	Exception- Flight Cancel
702	700	Exception- Offload by Airline
703	700	Exception- Flight mechanical issue
704	700	Exception- Weather delay
705	700	Exception- Curfew
706	700	Exception- Holiday event
707	700	Exception- Content mismatch
708	700	Exception- Misroute
709	700	Exception - Missing Paperwork
710	700	Exception - Missing Shipment
711	700	Exception- Other
718	700	Exception - Unmapped Tracking Event
719	700	Exception/Problem Resolved - In Transit
720	700	Delay
721	700	Delay - Arrival at Incorrect Facility
723	700	Delay - Weather/Natural Disaster
724	700	Delay - Extra Carrier Processing
725	700	Delay - Traffic
726	700	Delay - Incorrect Address/Address Correction
727	700	Delay - Bulky Shipment
728	700	Delay - Dangerous Goods
729	700	Delay - Other
730	700	Rejected at GPS/Partner Facility - Invalid Tracking Number
731	700	Rejected at GPS/Partner Facility - Delivered to Incorrect Facility
732	700	Rejected at GPS/Partner Facility - Over Weight Limit
733	700	Rejected at GPS/Partner Facility - Over Dimension Limit
734	700	Delivered to Incorrect Facility - Label Replaced
735	460	Undeliverable- PO Box delivery not allowed
736	460	Undeliverable- Out of service coverage
740	460	Undeliverable- Damage
741	460	Undeliverable- Lost/Stolen
744	460	Undeliverable- Traffic control
745	460	Undeliverable- Abandon
746	460	Undeliverable- Public Holiday
747	460	Undeliverable- Parcel content mismatch
750	460	Undeliverable- Incorrect Address
751	460	Undeliverable- Incomplete address
752	460	Undeliverable- Missing Suite/Apt #
753	460	Undeliverable- Address correction requested
754	460	Undeliverable- Missing contact number
755	460	Undeliverable- No such person
756	460	Undeliverable- Consignee is not available
757	460	Undeliverable- Consignee moved
758	460	Undeliverable- Valid consignee ID not available
759	460	Undeliverable- Shipment forwarded to different address
760	460	Undeliverable- Unable to Forward
761	460	Undeliverable- Password required
762	460	Undeliverable- Permission for entry is required
763	460	Undeliverable- Weekend closure
764	460	Undeliverable-Failed to Forward to New Address
770	700	Wrong Label
771	700	Incorrect Sort
780	460	Undeliverable- Refused by customer
781	460	Undeliverable- Refused by customer - Custom Charges
782	460	Undeliverable- Refused by customer - Did Not Order
783	460	Undeliverable- Refused by customer - Cancelled Order
784	460	Undeliverable- Refused by customer - Duplicate Order
785	460	Undeliverable- Refused by customer - Late Delivery
786	460	Undeliverable- Refused by customer - Damaged
790	460	Undeliverable- Returned to Seller
791	460	Undeliverable- Returned to Sender - Incorrect Address
792	460	Undeliverable- Returned to Seller - Damaged
793	460	Undeliverable- Returned to Seller - Refused by Customer
794	460	Undeliverable- Returned to Sending Facility
799	460	Undeliverable- Other
800	800	Label Cancelled
900	900	Delivered
901	900	Delivered- Accesspoint/Post Office
902	900	Delivered- Mailbox
903	900	Delivered- Locker
904	900	Delivered- Front Desk
905	900	Delivered- Porch/Gargage/Front door/Side Door
906	900	Delivered- PO Box
907	900	Delivered- Other
908	900	Delivered - SIGNATORY
909	900	Delivered - FRONT DOOR
910	900	Delivered - SIDE DOOR
911	900	Delivered - BACK DOOR
912	900	Delivered - GARAGE
913	900	Delivered - SUPERINTENDENT
914	900	Delivered - PARCEL BOX
915	900	Delivered - LOCK BOX
916	900	Delivered - NEIGHBOR
920	900	Delivered - Back to Sender
921	900	Delivered - Return Delivery to Sender
950	900	Picked up
951	900	Picked up - Held Package