- Previous: Global Tracking Booking API Documentation
- Up:
- Next:
Warehouse Management Solutions
Guide to Warehouse Management Solutions
Connecting Your Business to Our Warehouse - Welcome to the JAS Warehouse Management System (WMS) Integration Suite. This standad implementation component version 1.0 collection of APIs provides a direct, automated link between your business applications (such as an ERP, e-commerce platform, or order management system) and our warehouse operations.
By integrating with these APIs, you can automate your entire inventory and order lifecycle. This eliminates manual data entry, reduces costly errors, and creates a single, real-time source of truth for your products, inbound receiving, and outbound fulfillment.
All transactions are available in both XML and JSON formats to provide maximum flexibility for your development team.
1. Product Master API
Business Purpose: To create and update all product information in the JAS WMS. This ensures our warehouse team knows exactly what items they are receiving, storing, and shipping on your behalf.
Key Business Value:
- Accuracy: Guarantees that all product data (SKUs, descriptions, dimensions) is correct, preventing mis-picks and shipping errors.
- Efficiency: Enables fast and accurate receiving of new inventory.
- Data Integrity: Serves as the single source of truth for all item-specific details.
Key Data Elements:
- SKU (Stock Keeping Unit) – The unique identifier for the product.
- ProductDescription – The customer-facing name or description.
- Dimensions (Length, Width, Height) – Critical for storage and shipping calculations.
- Weight – Used for shipping and handling.
- UPC / EAN – Barcode numbers for scanning.
- UnitOfMeasure (e.g., Each, Case, Pallet).
2. Purchase Order (Inbound) API
Business Purpose: To give our warehouse advanced notice of an incoming delivery, including what products are on it and when it is expected.
Key Business Value:
- Planning: Allows JAS to schedule dock appointments and allocate labor for efficient unloading.
- Speed: Drastically accelerates the receiving process; we can scan your items against your PO instead of manually counting and identifying them.
- Visibility: Your system gets real-time visibility into when your new inventory is received and available for sale.
Key Data Elements:
- PurchaseOrderNumber – Your unique reference number for the inbound shipment.
- SupplierName – Who is sending the inventory.
- ExpectedArrivalDate – The date you expect the shipment to arrive at the warehouse.
- LineItems (A list of products):
- SKU
- QuantityExpected
3. Sales Order (Outbound) API
Business Purpose: To automatically transmit customer orders from your sales system (e.g., Shopify, Magento, SAP) to our warehouse for fulfillment.
Key Business Value:
- Automation: Creates a "hands-off" process from the moment your customer clicks "buy" to the order being packed and labeled by our team.
- Speed: Orders are sent to the warehouse floor for picking in real-time, significantly reducing order processing time.
- Scalability: Allows you to process thousands of orders per day without manual intervention.
Key Data Elements:
- CustomerOrderNumber – Your unique identifier for the sale (e.g., your e-commerce order ID).
- ShipToAddress (Name, Street, City, Postal Code, Country) – The end customer's details.
- RequestedShipMethod (e.g., "Ground," "Next Day Air").
- LineItems (A list of products):
- SKU
- QuantityOrdered
4. Return Authorization (RMA) API
Business Purpose: To give the warehouse advance notice of an incoming customer return, including what product is being returned and why.
Key Business Value:
- Efficient Returns: Allows our team to quickly receive, identify, and inspect the returned item.
- Faster Credits: Enables you to issue customer refunds or exchanges more quickly.
- Inventory Control: Provides a clear process for inspecting goods and placing them back into "Available" stock or "Quarantined" stock based on their condition.
Key Data Elements:
- RMANumber – The unique reference number for the return.
- OriginalOrderNumber – The sales order the return is associated with.
- ReturnFromAddress – The customer's address.
- LineItems (A list of products):
- SKU
- QuantityExpected
- ReturnReason (e.g., "Damaged," "Wrong Item," "Unwanted").
5. Sales Order Cancellation API
Business Purpose: To provide an automated method to stop a shipment before it leaves the warehouse, typically due to a customer request or fraud detection.
Key Business Value:
- Cost Savings: Prevents unwanted shipments, saving on both outbound shipping and return processing costs.
- Customer Satisfaction: Allows you to respond quickly to your customers' cancellation requests.
- Responsiveness: Provides an immediate API-driven attempt to halt an order.
Key Data Elements:
- CustomerOrderNumber – The unique ID of the Sales Order you wish to cancel.
The Payoff: The API will respond with a message indicating if the cancellation was successful. A cancellation may fail if the order has already been picked and loaded onto a truck.
Developer Resources
Get started with your integration by using the resources below. All endpoints accept both application/xml and application/json content types.
Authentication
All API requests must be securely authenticated using OAuth 2.0. Accessing the API is a two-step process.
Step 1: Generate an Access Token
Before you can call the WMS endpoints, you must request a bearer token using the client_credentials grant type.
Method: POST
Endpoint: https://<URL_PROVIDED _IN_THE_PORTAL>/v2.0/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 Warehouse Management Solutions API
Once you have your access token, you can call the API resources. 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 |
Resource Endpoints
All these endpoints use the POST method. The base URL (host) will be provided for both Test and Production environments.
| Transaction | JSON Endpoint | XML Endpoint |
|---|---|---|
| Product Master | .../v1/WMS/ProductMasterJSON/ | .../v1/WMS/ProductMasterXML/ |
| Purchase Order | .../v1/WMS/PurchaseOrderJSON/ | .../v1/WMS/PurchaseOrderXML/ |
| Sales Order | .../v1/WMS/SalesOrderJSON/ | .../v1/WMS/SalesOrderXML/ |
| Return (RMA) | ...v1/WMS/ReturnJSON/ | ...v1/WMS/ReturnXML/ |
| Sales Order Cancel | .../v1/WMS/SalesOrderCancellationInJSON/ | .../v1/WMS/SalesOrderCancellationInXML/ |
| Subscribe | .../v1/WMS/subscribe/ |
This endpoint uses the GET method. The base URL (host) will be provided for both Test and Production environments.
| Transaction | JSON Endpoint |
|---|---|
| List Subscription | ...v1/WMS/listsubscriptions/{customercode}/{warehousecode} |
Error Handling
The API uses standard HTTP response codes to indicate the success or failure of a request. You can expect the following common codes:
- 200 Success: Your transaction was successfully received.
- 400 Bad Request: There is an error in your request payload (e.g., missing data, invalid format).
- 401 Unauthorized: Your Authorization token or x-api-key is missing, invalid, or expired.
- 404 Not Found: The URL endpoint you are trying to reach is invalid.
- 500 Internal Server Error: An unexpected error occurred on the JAS server.
- Previous: Global Tracking Booking API Documentation
- Up:
- Next:
0 Comments
Please sign in to post a comment.