Ship Load
The Ship Load API allows you to ship a load by uploading the load via ID or filter.
| Category | Name | Required | Type | Description |
|---|---|---|---|---|
| parameters | load_nbr | X | string | Load for shipping |
| parameters | facility_id | Integer | Facility context by id | |
| parameters | facility_id__code | string | Facility context by code | |
| parameters | company_id | Integer | Company context by id | |
| parameters | company_id_code | string | Company context by code | |
Load Lookup by ID
POST .../entity/load/{id}/ship/
- No additional `parameters` data in the request body is required.
Load Lookup by Filters
POST .../entity/load/ship/
Example Request Body:
{
"parameters": {
"facility_id__code": "FAC-1",
"company_id_code": "COM-1",
"load_nbr": "LOAD-1"
}
}This API includes the following features:
- Supports the ship load transaction for a load that is in the Loaded/ Loading Started /Checked Out status.
- An error is displayed if the load is in a "Cancelled", "Ship Load In Progress", or "Shipped" status.
- The shipload transaction can be performed either by providing the id or code for the company/facility along with the load number.
- A Ship Load confirmation file is generated after the load is shipped.
Once a load is shipped via the Ship Load API, the following applies to Inventory History Transaction (IHT) records:
- Inventory history IHT -3 '3 - Container Shipped' is written with respect to each container present on the load.
- For shipped loads with OBLPNs associated with asset inventory history, IHT- 58 '58 - Asset Shipped' is written with respect to each OBLPN associated with an asset.
- Inventory history IHT- 60 '60 - Load Shipped File' is written for the outbound Load shipped.
The Ship Load API supports the following validations:
Ship Load API supports Order type with ''Single Order on multiple Loads':
- If "Single Order on multiple Loads" is set to "Do not Allow" in the order type, the system displays the error message: "Load has Order/s marked to Prevent one order on different loads with Error."
- When an order is in Packed status but only some of the packed OBLPNs are loaded.
- When an order is in Packed status but some OBLPNs are loaded to different loads.
- For OBLPNs with pending audit if the Company parameter "ALLOW_LOAD_SHIP_WITH_AUDIT_PENDING" is set to no.
Company Parameter REQD_FIELDS_FOR_SHIPPING is defined:
- When the required fields configured for the parameter 'REQD_FIELDS_FOR_SHIPPING ' are not defined for the targeted load.
- When one of the container item on the load is serial number tracked and the number of serial numbers allocated do not match with the count of serial numbers present in the container.
Serial Number Validations
- If company parameter ALLOW_LOAD_SHIP_WITH_AUDIT_PENDING = False and company parameter SERIAL_NUMBER_TRACKING_LEVEL is 1 or 2
- If company parameter SERIAL_NUMBER_TRACKING_LEVEL is 0 or Non serial tracked items exist and company parameter ALLOW_LOAD_SHIP_WITH_AUDIT_PENDING = False
- This API will not show you any warning message like the UI or RF, and it will proceed with the Ship Load transaction.
- The Ship Load API does not generate multiple outbound files.