- Previous: Forwarding Order API Documentation
- Up:
- Next: Transport API
Forwarding Order Tracking API Documentation
Guide to Forwarding Tracking API
Welcome to the JAS Connect Forwarding Tracking API. This service allows your business applications (like an ERP, TMS, or e-commerce platform) to communicate directly with our core systems.
By integrating with this API, you can automate your entire order status process, enabling your systems to directly know the status of your order with JAS in an easy and automated way. This guide provides a complete overview of how to use the Forwarding Order Tracking API services to know the status of your orders.
Key Capabilities & Features
Our Forwarding Order Tracking API is a powerful, REST-based service designed for simplicity, security, and accuracy.
- Get Forwarding Orders Status: The API's primary function is to get the Status of Orders in the JAS system. Orders status can be easily fetched by providing basic information about the Order Number, Order Split Number, Client/Buyer Code.
- Flexible Data Formats:We support both major data formats for your convenience. You can submit your order requests in either
application/jsonorapplication/xml. - 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.
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 get a Forwarding Order Status, 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 Forwarding Order Tracking API
Once you have your access token, you can call the ForwardingOrderStatus endpoint.
- Method:
POST -
Required Headers: Authorization Bearer <<ACCESS_TOKEN>> Content-Type application/json or application/xml - API Endpoints:
- Resources:
- JSON:
/v1/ForwardingOrder/ForwardingOrderStatusjson - XML:
v1/ForwardingOrder/ForwardingOrderStatusxml
- JSON:
Understanding the API Flow
The process of creating an order is straightforward.
1. Request Validation
When JAS receives your ForwardingOrderStatus request, our system first validates it. This check ensures:
- Your Authentication headers (Authorization) should be valid.
- Your Content-Type header matches the endpoint (e.g., application/json for the CreateForwardingOrderjson endpoint).
- Your payload structure is correct and all mandatory fields are included. A "Bad Request" error (400) will be returned if there are mismatches.
2. Forwarding Order Tracking & Receive Confirmation
After a successful validation, JAS provides the Forwarding Order Tracking 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:"Success": true"PO124567~1~UNMATCHED"(This is your new JAS Order ID)
- On Failure: You will receive a response with:
"Success": false"Error": "Detailed error message..."- This can be due to business logic errors or unexpected server issues (e.g.,
500 Internal Server Error).
Core Data Structure
An Order Tracking Request is built from these primary data collections.
- Order Number: This section consists of unique order ID and environment details.
- Order Split Number: The main information about the supplier and the buyer party.
- ClientOrgCode: This section consists of the information about the purchase order.
An Order Status Response data is built from these primary Collections.
- Order Details: This section provides header details about your order and the orders current status.
- Milestones: Milestones provide dates and times for specific events in the order lifecycle.
Milestone Descriptions Order Placed Order Confirmed with Supplier order Picked Up Origin Order Booked with Carrier Departure Arrival Order Delivered Order Cancelled Customs Cleared
Full specification documents are available for your review using the link above.
- Previous: Forwarding Order API Documentation
- Up:
- Next: Transport API
0 Comments
Please sign in to post a comment.