| Scenario | Subscription Type | Parameters | Remarks |
|---|---|---|---|
| Normal subscription | B/L No. / Booking No. / Container No. subscription | "referenceNo": "B/L No. / Booking No. / Container No." (choose one of the three) "blType":"" (BL=B/L No. / BK=Booking No. / CN=Container No. / ""=auto-detect) "carrierCd": "Ocean carrier code" | blType can be empty; Trackingeyes auto-detects it from the document number |
| One shipment with multiple containers but only one container's information is needed | B/L No. / Booking No. + specified single container subscription | "referenceNo": "B/L No. / Booking No." (choose one) "ctnrNo": "specified container number" "blType":"" (BL=B/L No. / BK=Booking No. / ""=auto-detect) "carrierCd": "Ocean carrier code" "extendNo":{"ctnrTrackId":"Y"} | 1. In this scenario the specific single container number must be uploaded to ctnrNo, and the extended field must upload the ctnrTrackId parameter in the required format 2. If information for multiple containers needs to be returned, each container number must be subscribed separately in this mode |
| Sinotrans (SINO) | B/L No. subscription for Sinotrans (SINO) | "referenceNo": "B/L No. "blType":"" (BL=B/L No. / ""=auto-detect) "carrierCd": "Ocean carrier code" "extendNo": {"ctnrNo":"one of the container numbers"} | 1. Container-number subscription can be used directly 2. When subscribing with a B/L No., the extended field must upload the ctnrNo parameter in the required format 3. To return the information of a specified container, ctnrNo must be that container number |
| The current status on the ocean carrier's official website is pick-up or empty-return, not a new process | Historical container subscription | "referenceNo": "Container No. "blType":"" (CN=Container No. / ""=auto-detect) "carrierCd": "Ocean carrier code" "extendNo":{"IncludeHistoryId":"Y"} | 1. In this scenario the system automatically determines it as a historical container. To obtain this data, the extended field must upload the IncludeHistoryId parameter in the required format 2. If the current status on the ocean carrier's official website is not pick-up or empty-return, assigning this scenario parameter makes the system return the latest current status instead of the status of the previous process |
| The ocean carrier is unknown | Ocean carrier auto-detect subscription (service must be activated separately) | "referenceNo": "Subscription No. "blType":"" (BL=B/L No. / BK=Booking No. / CN=Container No. / ""=auto-detect) "carrierCd": "AUTO | |
| Terminal data is needed to supplement release and inspection | Consolidated API data subscription (ocean carrier + terminal) (service must be activated separately) | "referenceNo": "B/L No. / Booking No. / Container No. (choose one of the three) "blType":"" (BL=B/L No. / BK=Booking No. / CN=Container No. / ""=auto-detect) "carrierCd": "Ocean carrier code" "polCd":"Port of loading code (polCd for export / podCd for import) "serviceType":"CT/CTP" (select the parameter according to the purchased type) | 1. The consolidated API does not support subscribing to terminal data only; if only terminal data is needed, please use the port area data API 2. When using the consolidated API with a container number or the consolidated API with a specified container, the etd (estimated sailing time) must also be provided New 3. To return the information of a specified container, the ctnrNo and ctnrTrackId parameters must also be uploaded as in type 4 above 4. CTP = enhanced consolidated API |