Welcome to the JAS Connect Forwarding 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 forwarding 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 forwarding 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)
• 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 Status API. You must include the token to every request/call .

• Method: POST

• Required Headers:
  Authorization	Bearer <<ACCESS_TOKEN>>
  Content-Type	application/json or application/xml

• API Endpoints:
  • Test: https://<<TEST_INSTANCE_URL_IN_PORTAL>>
  • Production: https://<<PROD_INSTANCE_URL_IN_PORTAL>>
• Resources:
  • JSON: /v1/shipments/{ShipmentorHouseBillNumber}/statusjson
  • XML: /v1/shipments/{ShipmentorHouseBillNumber}/statusxml

Understanding the Request

You must pass the identifier in the URL path.

• Path Parameter: {ShipmentorHouseBillNumber}
  • This dynamic part of the URL is where you will insert your query value (e.g., S505185992).
• Identifier Logic: The API automatically determines the type of identifier you sent:
  1. If the value starts with an 'S' followed by 9 digits, it's treated as a Shipment Number.
  2. Otherwise, it's treated as a House Bill Number.
  3. If a House Bill Number is sent, the system first looks up the corresponding Shipment Number to retrieve the data. If no shipment is found for the given ID, 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

• 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).
• ETD / ETA: 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 .