ICTSI ============================================================================= :Provider Information: +-----------------+-----------------------------------+ | **Id** | ictsi | +-----------------+-----------------------------------+ | **Type** | terminal | +-----------------+-----------------------------------+ | **Trace Type** | API | +-----------------+-----------------------------------+ | **Credentials** | Subscrition ID and Key for Envase | +-----------------+-----------------------------------+ | **Status** | draft | +-----------------+-----------------------------------+ | **Doc Status** | draft | +-----------------+-----------------------------------+ | **Doc Version** | 1 | +-----------------+-----------------------------------+ :URLs: +---------+-------------------------------------+-------------+ | Type | URL | Environment | +=========+=====================================+=============+ | Request | https://api.ictsi.net/external/tnt/ | PRD | +---------+-------------------------------------+-------------+ :Sites: +-------+---------+-----------------+ | Name | Site Id | Description | +=======+=========+=================+ | SBITC | SBITC | the description | +-------+---------+-----------------+ .. note:: ICTSI supports only one Site which is SBITC, but other sites will be added to this provider over time. :API ID: +-----------------------+--------------------+------------------------------------+ | API | id | Description | +=======================+====================+====================================+ | getBookingDetails | booking | x-api-id for getBookingDetails | +-----------------------+--------------------+------------------------------------+ | getCustomer | customer | x-api-id for getCustomer | +-----------------------+--------------------+------------------------------------+ | getTruckEvent | truck-event | x-api-id for getTruckEvent | +-----------------------+--------------------+------------------------------------+ | getTruckTransactions | truck-transactions | x-api-id for getTruckTransactions | +-----------------------+--------------------+------------------------------------+ | getTruckVisitDetails | truck-visit | x-api-id for getTruckVisitDetails | +-----------------------+--------------------+------------------------------------+ | getVesselVisitDetails | vessel-visit | x-api-id for getVesselVisitDetails | +-----------------------+--------------------+------------------------------------+ | getVesselEvent | vessel-event | x-api-id for getVesselEvent | +-----------------------+--------------------+------------------------------------+ :Credentials: .. important:: Credentials are Envase based. .. code-block:: json { "x-subscription-id": "enter subscription id", "Ocp-Apim-Subscription-Key": "enter subscription key" } Request ----------------------------------------------------------------------------- .. important:: Booking information are returned through two separate requests, The first one is to get the booking information, and the other is to return active vessel info associated to the booking which mainly contains the information for getting all the Earliest Loading Date and all the cut offs. Query Booking Request ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Query bookings using the following two requests by adding the credentials in header in the request as following. First request to get the booking information. .. code-block:: shell POST https://api.ictsi.net/external/tnt/api/v2/getBookingDetails?facility-id=SBITC&booking-nbr={BOOKING-ID} :Request Headers: .. code-block:: json { "x-subscription-id": "enter subscription id", "Ocp-Apim-Subscription-Key": "enter subscription key", "x-api-id": "container", "x-request-product-id": "track-and-trace" } Second request to get the active vessel info associated to the booking. .. code-block:: shell POST https://api.ictsi.net/external/tnt/api/v2/getVesselVisitDetails?carrier-visit-id={CARRIER-VISIT-ID}&facility-id=SBITC :Request Headers: .. code-block:: json { "x-subscription-id": "enter subscription id", "Ocp-Apim-Subscription-Key": "enter subscription key", "x-api-id": "vessel-visit", "x-request-product-id": "track-and-trace" } Responses ----------------------------------------------------------------------------- Query Bookings Response ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: shell POST https://api.ictsi.net/external/tnt/api/v2/getBookingDetails?facility-id=SBITC&booking-nbr=131DA00221 Next response is for booking 131DA00221. .. code-block:: json { "data": [ { "unique_key": "N4PH-TOS/PH/6274", "operator_id": "ICTSI", "complex_id": "PH", "facility_id": "SBITC", "booking_nbr": "203901523", "vessel_visit_id": "MCC0042-20", "vessel_visit_phase": "70CLOSED", "vessel_name": "NAVIOS TEMPO", "ob_vyg": "028N", "freight_kind": "FCL", "quantity": "1", "category": "EXPRT", "tally_in": "1", "tally_out": "0", "shipper": "SENG HONG SUBIC COMPANY LIMITED", "shipper_name": "SENG HONG SUBIC COMPANY LIMITED", "consignee": "", "consignee_name": "", "trucking_company": "BUMIJAYA", "origin": "", "destination": "SINGAPORE", "pol": "PHSFS", "pod1": "SGSIN", "pod2": "", "is_live_reefer": false, "is_hazardous": true, "visit_details_gkey": "ICTSI/PH/SBITC/157994", "is_oog": false, "order_items": [ { "is_oog": "false", "eq_iso_group": "GP", "rfr_type": "NON_RFR", "temp_required": null, "is_hazardous": "false", "tally_limit": null, "eq_size": "NOM40", "ord_tally": "0", "qty": "1", "material": "UNKNOWN", "eq_iso_id": "45G1", "rcv_limit": null, "eq_class": "CONTAINER", "eq_desc": "40ft hi-cube general", "eq_height": "NOM96" } ], "created": "2020-07-15T15:31:39.167Z", "changed": "2020-07-17T08:51:04.267Z", "lineOperator": "MCS" } ], "extra": { "updatedTime": "2023-07-07T13:57:19Z" } } Not found Booking Response ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: shell POST https://api.ictsi.net/external/tnt/api/v2/getBookingDetails?facility-id=SBITC&booking-nbr=61873611 If Booking id 61873611 is returned as not found then API returns the next response. .. code-block:: json { "data": [], "extra": { "updatedTime": "2023-04-14T13:27:55Z" } } Query Active Vessels Response ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: shell POST https://api.ictsi.net/external/tnt/api/v2/getVesselVisitDetails?carrier-visit-id=WHL0025-23&facility-id=SBITC Next response is for all the active vessels. .. code-block:: json { "data": [ { "unique_key": "ICTSI/PH/SBITC/1294471", "terminal_operator_id": "ICTSI", "complex_id": "PH", "facility_id": "SBITC", "carrier_visit_id": "WHL0025-23", "carrier_name": "WAN HAI 231", "lloyds_id": "9208150", "carrier_mode": "VESSEL", "visit_nbr": "0", "visit_phase": "60DEPARTED", "carrier_operator_id": "WHL", "carrier_operator_name": "WAN HAI LINES LTD.", "eta": "2023-03-22T03:30:00.000Z", "ata": "2023-03-22T03:22:00.000Z", "etd": "2023-03-22T10:00:00.000Z", "atd": "2023-03-22T10:01:00.000Z", "begin_receive": "2023-01-01T00:00:00.000Z", "cargo_cutoff": "2023-03-22T07:00:00.000Z", "haz_cutoff": "null", "reefer_cutoff": "null", "labor_onboard": "2023-03-22T03:53:00.000Z", "labor_offboard": "2023-03-22T09:40:00.000Z", "arrival_off_port": "2023-03-22T02:10:00.000Z", "departure_off_port": "null", "pilot_onboard": "2023-03-22T02:40:00.000Z", "pilot_offboard": "2023-03-22T02:40:00.000Z", "start_work": "2023-03-22T06:00:00.000Z", "end_work": "2023-03-22T09:22:00.000Z", "classification": "DEEPSEA", "estimated_load_moves": 11, "estimated_discharge_moves": 84, "estimated_restow_moves": null, "estimated_shift_onboard_moves": null, "estimated_breakbulk_load_moves": null, "estimated_breakbulk_discharge_moves": null, "countrycode": "SG", "visit_details_gkey": "ICTSI/PH/SBITC/1287620", "flex_string01": "null", "flex_string02": "SBITC", "flex_string03": "ON WINDOW", "ib_vyg": "S373", "ob_vyg": "N374", "quay_id": "1", "quay_name": "1", "service_id": "MHT", "service_name": "WAN HAI ", "remarks": "null", "est_time_of_completion": "null", "initial_time_of_completion": "null", "amended_est_time_of_completion": "null", "estimated_time_of_berthing": "2023-03-22T03:30:00.000Z", "actual_time_of_berthing": "2023-03-22T03:22:00.000Z", "loading_cutoff": "null", "export_cutoff": "2023-03-22T07:00:00.000Z", "etb_lct": "null", "vessel_registry_number": "WHL0025-23", "begin_receive_empty": "null", "running_total_export_empty_teu": "null", "export_empty_allocation_teu": "null", "vessel_statuses": [ { "language": "en-us", "description": "Departed" }, { "language": "hr-hr", "description": "Otišao" }, { "language": "ar-iq", "description": "نشط في مرسى" } ] } ], "extra": { "updatedTime": "2023-04-14T16:29:16Z" } } :Data Mapping: +-----------------------------------------+-------------------------------+------------------------------------------+ | Property | Source Property | Description | +=========================================+===============================+==========================================+ | id | booking_nbr | Identifier of the booking. | +-----------------------------------------+-------------------------------+------------------------------------------+ || providerId || DEFAULTED || Identifier of the provider providing | || || || the data defaulted to ictsi. | +-----------------------------------------+-------------------------------+------------------------------------------+ || locationCode || facility_id || Terminal specific identifier of the | || || || location | +-----------------------------------------+-------------------------------+------------------------------------------+ | steamshipLine | carrier_operator_id | Steamship line identifier/SCAC | +-----------------------------------------+-------------------------------+------------------------------------------+ | vessel | carrier_name | Identifier of the vessel. | +-----------------------------------------+-------------------------------+------------------------------------------+ | vesselNumber | lloyds_id | Reference number for the vessel. | +-----------------------------------------+-------------------------------+------------------------------------------+ | vesselVisitId | visit_details_gkey | Reference key for the vessel information | +-----------------------------------------+-------------------------------+------------------------------------------+ | voyage | ob_vyg | Reference number for the voyage. | +-----------------------------------------+-------------------------------+------------------------------------------+ | earliestLoading | begin_receive | Date/Time when loading starts. | +-----------------------------------------+-------------------------------+------------------------------------------+ | eta | eta | Estimated time to arrival. | +-----------------------------------------+-------------------------------+------------------------------------------+ | arrived | ata | Date/Time the vessel arrived. | +-----------------------------------------+-------------------------------+------------------------------------------+ | etd | etd | Estimated time to departure. | +-----------------------------------------+-------------------------------+------------------------------------------+ | departed | atd | Date/Time the vessel departed. | +-----------------------------------------+-------------------------------+------------------------------------------+ | cutoff | cargo_cutoff | General cargo cutoff date/time. | +-----------------------------------------+-------------------------------+------------------------------------------+ | reeferCutoff | reefer_cutoff | Refrigerated cargo cutoff date/time. | +-----------------------------------------+-------------------------------+------------------------------------------+ | hazmatCutoff | haz_cutoff | Hazmat cargo cutoff date/time. | +-----------------------------------------+-------------------------------+------------------------------------------+ | hazmat | is_hazardous | Allows hazardous cargo. | +-----------------------------------------+-------------------------------+------------------------------------------+ | reefer | is_live_reefer | Allows refrigerated cargo. | +-----------------------------------------+-------------------------------+------------------------------------------+ | oogAllowed | is_oog | Allows Out of Guage Freight. | +-----------------------------------------+-------------------------------+------------------------------------------+ || tracedAt || DEFAULTED || Defaulted to time where the booking | || || || was traced | +-----------------------------------------+-------------------------------+------------------------------------------+ | lastProviderUpdate | changed | Date/Time the provider updated the data. | +-----------------------------------------+-------------------------------+------------------------------------------+ || bookingDetails[n].temperature_required || order_items[n].temp_required || Part of booking and its the required | || || || temperature for a group of containers. | +-----------------------------------------+-------------------------------+------------------------------------------+ || bookingDetails[n].container_iso || order_items[n].eq_iso_id || Part of booking details and its the | || || || container iso id. | +-----------------------------------------+-------------------------------+------------------------------------------+ || bookingDetails[n].container_description|| order_items[n].eq_desc || Part of booking details and its the | || || || container description. | +-----------------------------------------+-------------------------------+------------------------------------------+ || bookingDetails[n].total_containers || order_items[n].qty || Part of booking details and its the | || || || total number of containers. | +-----------------------------------------+-------------------------------+------------------------------------------+ || bookingDetails[n].loaded_containers || order_items[n].ord_tally || Part of booking details and its the | || || || number of loaded containers. | +-----------------------------------------+-------------------------------+------------------------------------------+ || bookingDetails[n].hazmat || order_items[n].is_hazardous || Part of booking details and it says if | || || || the containers has hazardous material. | +-----------------------------------------+-------------------------------+------------------------------------------+ || bookingDetails[n].reefer || order_items[n].rfr_type || Part of booking details and it says if | || || || the containers are refrigerated. | +-----------------------------------------+-------------------------------+------------------------------------------+ || bookingDetails[n].oog_allowed || order_items[n].is_oog || Part of booking details and it says if | || || || the containers are out of guage. | +-----------------------------------------+-------------------------------+------------------------------------------+