- Previous: Global Tracking Shipment API Documentation
- Up:
- Next: Warehouse Management Solutions
Global Tracking Booking API Documentation
Guide to JAS Connect Booking Status API
Welcome to the JAS Connect Forwarding Booking Status API. This service provides a direct, real-time connection to our Transportation Management System (TMS) to retrieve the latest status and tracking updates for your forwarding bookings.
By integrating this API, your internal systems (such as an ERP, customer service portal, or visibility dashboard) can automatically query and display the status and milestones of any forwarding booking, providing up-to-the-minute visibility for your team and customers.
Key Capabilities & Features
Our Booking Status API is a REST-based service designed for flexibility, security, and accuracy.
- Real-Time Tracking: Provides live tracking and status updates for forwarding bookings managed within the JAS TMS.
- Flexible Querying: Retrieve booking data using either:
- JAS Booking Number (e.g.,
S505185992) - House Bill Number (e.g.,
PAR45176295)
- JAS Booking Number (e.g.,
- Choice of Formats: Responses available in
application/jsonorapplication/xml. - Secure & Encrypted: OAuth 2.0 authentication and HTTPS ensure secure data transmission.
- Rich Data Response: Returns detailed data including ETD/ETA, milestones, and transport legs.
Getting Started: Authentication & Endpoints
All API requests must be securely authenticated using 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 and your unique API key in the headers of every request .
- Method:
POST - Required Headers:
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:
- Resources:
- JSON:
/v1/api/shipments/forwarding/{ShipmentorHouseBillNumber}/statusjson - XML:
/v1/api/shipments/forwarding/{ShipmentorHouseBillNumber}/statusxml
- JSON:
Understanding the Request
You must include the identifier in the URL path using the {ShipmentorHouseBillNumber} parameter.
- Identifier Logic:
- If value starts with ‘S’ followed by 9 digits → treated as a Booking Number.
- Otherwise → treated as a House Bill Number.
- If a House Bill Number is sent, the system first looks up the corresponding Booking Number.
- If no booking is found, a
400 Bad Requestis returned.
Understanding the Response
The API returns detailed booking information in JSON or XML depending on your Content-Type header.
- BookingUniqueNumber: The official JAS Booking ID (e.g.,
S505185992). - HouseBillNumber: The House Bill number for the booking.
- GoodsDescription: Description of the cargo.
- ServiceLevel: The service code (e.g.,
STD). - ETD / ETA: Estimated departure and arrival times.
- Milestones: List of all tracking events.
MilestoneCode(e.g., ARV, DEP, PCF)MilestoneDescription(e.g., "Arrival at Final Discharge Port")LocalEstimatedDate/LocalActualDate
- Transports: Details of all transport legs.
Mode(e.g., Air, Sea)Voyage_FlightorVesselLoadingPort/DischargePortEstimatedDeparture/EstimatedArrival
- Containers: List of container numbers (if applicable).
- Consols: List of consolidation numbers (if applicable).
- Previous: Global Tracking Shipment API Documentation
- Up:
- Next: Warehouse Management Solutions
0 Comments
Please sign in to post a comment.