• Register

Global Tracking Registered Shipment API Documentation

Guide to Global Tracking Registered Shipment API

API Spec⬇️ API ConsolePostman Collection⬇️

Welcome to the JAS Connect Registered Shipment Status API. This service provides a direct, real-time connection to our Transportation Management System (TMS) to retrieve the latest tracking information for your shipments. 

By integrating this API, your internal systems (like an ERP, customer service portal, or visibility dashboard) can automatically query and display the status and milestones of any shipment, providing up-to-the-minute visibility for your team and your customers. 

Key Capabilities & Features 

Our Shipment Status API is a REST-based service designed for flexibility, security, and accuracy. 

  • Real-Time Tracking: Provides live tracking and status updates for shipments managed within the JAS TMS. 

  • Flexible Querying: You can retrieve shipment data using the identifier that is most convenient for your workflow: 

  • JAS Shipment Number (e.g., S505185992) 

  • House Bill Number (e.g., PAR45176295) 

  • Reference Number (e.g., PO1234567) Note that Reference Number locations in the JAS system are Additional References and Order Refs.  This DOES NOT apply to business that attaches actual orders to shipments. 

  • Container Number (e.g., MEAU1234567)  

  • Required Querying: The JAS Organization code(s) that was assigned to your account are required for this API call : 

  • JAS System Organization Code (e.g., MATTESRDU) 

  • Choice of Formats: You can request the API response in either application/json or application/xml by setting the Content-Type header. 

  • Secure & Encrypted: All API communication is secured. We use the OAuth 2.0 protocol for authentication , and all web calls are made over HTTPS to ensure your data is always encrypted in transit. 

  • Rich Data Response: The API returns a comprehensive set of data, including estimated/actual departure and arrival times, a full list of shipment milestones, and details on transport legs (like flight or vessel numbers) . 

Getting Started: Authentication & Endpoints 

All API requests must be securely authenticated. Accessing the API is a two-step process. 

Step 1: Generate an Access Token 

Before you can request a shipment's status, you must get a bearer token using the OAuth 2.0 client_credentials grant type. 

  • Method: POST 

  • Endpoint: https://<<URL_PROVIDED _IN_THE_PORTAL/oauth2/token 

  • Headers: Content-Type: application/x-www-form-urlencoded 

Body parameters 

Values 

grant_type 

client_credentials 

client_id 

<YOUR_CLIENT_ID> 

client_secret 

<YOUR_CLIENT_SECRET> 

Step 2: Call the Shipment Status API 

Once you have your access token, you can call the Registered Status API. You must include the token and your unique API key in the headers of every request . 

  • Method: POST 

Required Headers: 

  

Authorization 

Bearer <<ACCESS_TOKEN>> 

x-api-key 

<<Key value sent by JAS Connect Team>> 

Content-Type 

application/json or application/xml 

  • API Endpoints: 

  • Test: https://<<TEST_INSTANCE_URL_IN_PORTAL>> 

  • Production: https://<<PROD_INSTANCE_URL_IN_PORTAL>> 

  • Resources: 

  • v1/registeredshipments/forwarding/statusxml

  • v1/registeredshipments/forwarding/statusjson

Understanding the Request 

You must pass one of the four numbers and an org code. 

  • Request Payload Parameters:  

  • ShipmentNumber - This is where you will insert into your query the Shipment Number  value. This is one of the four optional data fields of which one is required.  

  • HouseBillNumber – This is where you would insert into your query the House Bill Number value. This is one of the four optional data fields of which one is required. 

  • ReferenceNumber – This is where you would insert into your query the Reference Number Value. This is one of the four optional data fields of which one is required.  

  • ContainerNumber – This is where you would insert into your query the Container Number value.  This is one of the four optional data fields of which one is required 

  • OrgCode – This is where you will insert into your query the JAS assigned organization code.  This field is Required for any query.  If you are unsure of your org code(s) please reach out to your JAS account team to assist in providing you with this information.  

  • Request Payload Logic 

  1. When a Shipment Number value and OrgCode value are sent, the system first verifies if the OrgCode is either the Shipper, Consignee or Controlling Customer on that specific shipment number. If no shipment is found for the given ShipmentNumber/OrgCode, the API will return a 400 Bad Request error . 

  1. If the HouseBillNumber value and OrgCode value find a matching shipment then the tracking information will be provided for that specific shipment. When a House Bill Number and OrgCode are sent, the system first looks up the corresponding Shipment Number to then verify if the OrgCode is either the Shipper, Consignee or Controlling Customer on that specific shipment number.  If no shipment is found for the given HouseBillNumber/OrgCode, the API will return a 400 Bad Request error . 

  1. When a ReferenceNumber value and OrgCode value are sent the system will find all shipments that contain that specific reference number and has a Shipper, Consignee or Controlling Customer of the provided OrgCode. The most recent shipment tracking information will be provided and will include a list of all the other shipment numbers that matched.  You may call the query using the additional shipment number/org code if needed. If no shipment is found for the given ReferenceNumber/OrgCode, the API will return a 400 Bad Request error . 

  1. When a Container Number value and OrgCode value are sent the system will find all shipments that contain that specific container number and has a Shipper, Consignee or Controlling Customer of the provided OrgCode. The most recent shipment tracking information will be provided and will include a list of all the other shipment numbers that matched.  You may call the query using the additional shipment number/org code if needed. If no shipment is found for the given ContainerNumber/OrgCode, the API will return a 400 Bad Request error . 

Understanding the Response 

The API provides a detailed response payload in either JSON or XML format, depending on the Content-Type header you specified . A successful 200 response will contain the following key information. 

Key Data Elements 

  • CurrentStatus: shows the current status of the shipment.  List of statuses and related events found below. 

  • ShipmentUniqueNumber: The official JAS Shipment ID (e.g., S505185992). 

  • HouseBillNumber: The House Bill number for the shipment (e.g., PAR45176295). 

  • GoodsDescription: A description of the cargo. 

  • ServiceLevel: The service code for the shipment (e.g., STD). 

  • Estimated Time Departure / Estimated Time Arrival: The main Estimated Time of Departure and Estimated Time of Arrival for the shipment . 

  • Milestones: An array of all tracking events associated with the shipment. Each milestone includes: 

  • MilestoneCode (e.g., ARV, DEP, PCF) 

  • MilestoneDescription (e.g., "Arrival at Final Discharge Port") 

  • LocalEstimatedDate or LocalActualDate 

Event Code  

Milestone Name  

Milestone Description  

Current Status Shown at Event Completion  

Add  

Shipment Added  

Shipment Data has been received/entered into JAS system  

Shipment Created  

Shipment Created  

PCF  

Picked Up  

Shipment has been picked up, and the Pickup date has been entered into the JAS system.  This is applicable when JAS controls the Pickup.  

Pickup Complete  

Origin Pickup  

Pick Up Complete (Actual Pick Up Date)  

Pickup Cartage Complete/Finalised  

 

 

 

IRP  

Cargo Received At CFS  

Shipment has been dropped at the interim facility before departure.  

Received At Interim Facility  

Cargo Received At CFS (Interim Receipt Date)  

ATC  

Booked with Carrier  

A booking has been made for the shipment with the carrier, and the details of the transport have been entered into the JAS system.  

Booked With Carrier  

Booked With Carrier  

Booking Confirmed  

Attached Shipment to Consol  

Attached Shipment To Consol  

DEP  

Departure From First Load Port  

The Shipment has departed first port under JAS control.  

Departed  

Departure from Origin Port/Terminal  

Departure From Origin Port/Terminal  

ARV  

Arrival at Dischard Port  

The shipment has Arrived at last port under JAS Control.  

Arrived  

Arrival at Last Discharge Port  

Arrival at Final Discharge Port  

Arrival at Destination Port/Terminal  

Arrival at Destination  

DLV  

Delivered  

The Shipment has been delivered to the delivery location.  This is applicable when JAS controls the delivery.  

Delivered  

Delivery Cartage Complete/Finalised  

Delivery Cartage Complete/Finalised (FCL)  

Delivery(FCL)  

DCF  

Delivery  

Delivery (LCL)  

Delivery Complete (Actual Delivery Date)  

 

  

  • Transports: An array of all transport legs for the journey. Each leg includes: 

  • Mode (e.g., "Air", "Sea") 

  • Voyage_Flight or Vessel (e.g., AA001, MSC ANAHITA) 

  • LoadingPort and DischargePort 

  • EstimatedDeparture and EstimatedArrival for that specific leg 

  • Containers: An array listing container numbers, if applicable . 

  • Consols: An array listing any consolidation numbers related to the shipment . 

  • Additional Shipments: An array listing shipment numbers found when using a reference number to search.  The status information will be for the most recent shipment and any other shipments that were matched will be listed here. 

  

 

version 12 as of 3 days ago by Vijay Raj

0 Comments

Please sign in to post a comment.