Welcome to the JAS Connect Transport API. This service allows your business applications (like an ERP, TMS, or e-commerce platform) to communicate directly with our Truckers.

By integrating with this API, you can automate your entire booking acknowledgment and booking status & document creation process with truckers, enabling your systems to directly manage freight with JAS in an easy and automated way. This guide provides a complete overview of how to use the Transport API services, including acknowledging booking requests (acceptance or rejection) with estimated dates and sending status & document updates as they occur through to completion. 

Key Capabilities & Features

Our Transport API is a powerful, REST-based service designed for simplicity, security, and accuracy. 

• Booking Acknowledgement: The primary function of this API is to enable Truckers to send Booking Acknowledgements to JAS through an API endpoint hosted by JAS.
• Status and Documents: The primary function of this API is to enable Truckers to send Status & Documents to JAS through an API endpoint hosted by JAS.
• Flexible Data Formats: We support both major data formats for your convenience. We can accept booking acknowledgment and status & documents in either application/json or application/xml.
• Broad Transport Mode Support: The API can be used to send booking acknowledgment and status & documents across our global network, including:
  • Air Freight
  • Sea Freight
  • Road Freight
• 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 data is encrypted.
• Robust Error Handling: The API provides clear and accurate error handling. You will receive standard HTTP response codes (like 400 Bad Request or 401 Unauthorized ) to help you debug any issues with your integration.

Prerequisites

Trucker Details: Our system validates the Trucker's active status by verifying the Trucker Sender ID and Trucker Name against our records. If the Trucker is not identified as active in our system, it will be necessary to work with your JAS account team to review and align the Trucker information accordingly. In addition, the data formats that the Trucker intends to submit through the API should be be communicated in advance to ensure proper configuration and processing within the system.

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 send booking acknowledgment or status & documents, you must request 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 Transport API

Once you have your access token, you can call the Booking Acknowledgement or the Booking Status endpoints.

• 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 (Method: POST ):
  • Booking Acknowledgement- 
    • JSON: /v1/TruckerIntegration/BookingRequestAcknowledgementJSON
    • XML: /v1/TruckerIntegration/BookingRequestAcknowledgementXML
  • BookingStatus:
    • JSON: /v1/TruckerIntegration/BookingRequestStatusJSON
    • XML: /v1/TruckerIntegration/BookingRequestStatusXML

Understanding the API Flow

The process of sending the Booking Acknowledgment or Status & Documents is straightforward. 

1. Request Validation

When JAS receives your BookingAcknowledgment/BookingStatus request, our system first validates it. This check ensures: 

• Your Authentication headers should be valid.
• Your Content-Type  header matches the endpoint (e.g., application/json for the BookingAcknowledgment/BookingStatus endpoints).
• Your payload structure is correct, and all mandatory fields are included. A "Bad Request" error (400) will be returned if there are mismatches.

2. BookingAcknowledgment/BookingStatus Confirmation

After a successful validation, JAS logs the Acknowledgement or the Status for the respective booking in our system. The API will return a synchronous response indicating the result:

• On Success (Code 200 ): You will receive a simple JSON or XML response with:
  • "status": "Success"
  • "statuscode": "200"
  • "message": "200 OK"
• On Failure: You will receive a response with:
  • "status": "Failure"
  • "statuscode": "400"
  • "message": "Trucker not registered with JAS OR Invalid JobNumber"
  • This can be due to business logic errors or unexpected server issues (e.g., 500 Internal Server Error ).

Core Data Structure

While the full specification is available, Booking Acknowledgement and Booking Status requests are built from these primary data collections. 

Booking Acknowledgement -

• SenderID: Defining the specific trucker as the Sender of the message.
• ReceiverID: Defining JAS as the Receiver of the message.
• Transaction Date and Time: Defines the date/time the transaction was generated from the trucker.
• JAS Unique Reference: The JAS shipment, consol etc. number that was sent in the booking request.
• JAS Related Job#: Warehouse Orders related Shipment. This is for registering Invoices (no costs are usually registered directly on Warehouse Jobs).
• Company Code: Defines the JAS entity to which the booking relates.
• ServiceType: Defines the trucker service type. PCF = Pickup, DLV = Delivery.
• Booking Status: Whether the trucker accepts or denies the booking request. Use the events:
  • ACK: Acknowledged
  • SVR: Service Requested
  • SVJ: Service Rejected)
• Trucker Reference: The truckers internal reference number for this booking. Create Reference number type “Trucker Reference”.
• Estimated Cost of Service: Defines the estimated cost of the service from the trucker.
• Estimated Service Currency: Defines the estimated currency of the cost of the service.
• Remarks: Trucker notes/remarks.

Booking Status -

• SenderID: Defining the specific trucker as the Sender of the message.
• ReceiverID: Defining JAS as the Receiver of the message.
• Transaction Date and Time: Defines the date/time the transaction was generated from the trucker.
• JAS Unique Reference: The JAS shipment, consol etc. number that was sent in the booking request.
• JAS Related Job#: Warehouse Orders related Shipment. This is for registering Invoices (no costs are usually registered directly on Warehouse Jobs). The milestone events should be PCF for export and DCF for import.
• Company Code: Defines the JAS entity to which the booking relates.
• Status Code: Code representing the status completed.
• Status Date & Time: The date and time the status occurred.
• NoteCollection: Allows you to add standard or custom notes to the shipment.
• Document Collection: Provides detailed information about the document(type,filename etc.).