Production Endpoint URI
https://host<prod>.intelliyms.com/api/external/<Site>/shipmentInfo
Method
POST
Input
Body:
{
“SHIPMENT_INFO”: {
“INTERFACE_NAME”: “string”, // Required
“INTERFACE_ID”: Integer, // Required
“WH_ID”: “string”, // Required
“CARCOD”: “string”, // Required
“ORDER_TYPE”: “string”, // Required
“SHIPMENT”: “string”, // Required
“SHIPMENT_TYPE”: “string”, // Required
“APPT_NUM”: “string”, // Optional
“APP_DATE”: “2025-05-26T14:30:00Z”, // Optional (ISO 8601 format recommended)
“HANDLING_METHOD”: “string”, // Optional
“PFF_FLAG”: true, // Optional (boolean)
“TRLR_ID”: “string”, // Optional
“TRLR_NUM”: “string”, // Optional
“TRACTOR_NUM”: “string”, // Optional
“TRLR_SEAL1”: “string”, // Optional
“TRLR_SEAL2”: “string”, // Optional
“ITEMS”: [ // Required for each item
{
“ITEM_CAT”: “string”, // Optional (Repeatable for multiple categories)
“ITEM_ID”: “string”, // Required
“ITEM_DESC”: “string”, // Required
“ITEM_QTY”: 0 // Required
}
],
“SOURCE_LOC”: “string”, // Required
“DEST_LOC”: “string”, // Required
“SUP_NUM”: “string”, // Optional
“SHIP_STATUS”: “string”, // Optional
“LINEHAUL_COST”: 0, // Optional
“FUEL_COST”: 0, // Optional
“ACC_COST”: 0, // Optional
“ATTR_VALUE1”: “string”, // Optional
“ATTR_VALUE2”: “string” // Optional
}
}
curl –location –request POST ‘https://host.intelliyms.com/api/external//shipmentInfo’ \
–header ‘ig-clientid: ‘ \
–header ‘ig-secret: ‘ \
Target Objects
SHIPMENT_INFO
Output
{
“status”: “success”,
“varMessage”: “Shipment data received successfully.”,
“interface_id”: 123456, // If INTERFACE_ID was generated or used
“timestamp”: “2025-05-26T14:35:00Z”
}
Authentication
Intelligate Provides API Key Authentication using custom headers
Authorization
Authorized via Rbac (Role based access control) defined in Azure Entra Id
Description
The Shipment Information interface sends key shipment details from the WMS to Intelligate, including item lists, quantities, and source/destination locations. This is essential for providing real-time visibility and coordination, enabling efficient yard operations, scheduling, and tracking.
Feature Limits / Controls
Azure Application gateway/Firewall provides SQL Injection/DDOS (Denial of Service)/Cross Site Scripting,bot protection feature. Rate-limiting on login attempts;
