Overview
Orders
The warehouse order is used to instruct the warehouse to pick, pack, and ship goods to your customer. There are three primary statuses for warehouse order processing (PRS), finalized (FIN), and canceled (CAN). When the order is first sent to the API after passing validation, it will immediately be in the processing status acknowledging the order is saved and awaiting action by the warehouse. The order also contains a collection of shipments. Most orders result in one shipment. The shipment has four primary statuses entered (ENT), picking (PIC), finalized (FIN), and canceled (CAN). An order will remain in the processing status until all shipments are either finalized or canceled. When the order is finalized, it is a confirmation that all original order lines have been shipped.
Understanding Order Shipments
An order can consist of one or more shipments. The order has three primary statuses: processing (PRS), finalized (FIN), and canceled (CAN). When you submit an order to the API and it passes validation, the order will immediately be in the processing status. The order will remain in the processing status until all shipments are either finalized or canceled. Once the order is finalized, it confirms that the warehouse has shipped all of the order lines listed under the related shipment.
The shipments list is a crucial part of each order. It is a collection of shipments associated with a specific order, and you can assume that one order will have one shipment unless instructed otherwise by your Logistics Plus representative. The order lines represent what is supposed to ship from the warehouse, while the shipment represents what actually shipped, what product attributes are on those individual lines, and if applicable which packages each line is contained within. This allows you to easily determine if the order was received in full, short, or over.
Each shipment has a status that can be one of the following:
- ENT: Entered
- HEL: Held
- PIC: In Picking
- FIN: Finalized
- CAN: Canceled
Understanding the shipments list and the status of each shipment is critical to tracking the progress of your order. By checking the status of each shipment, you can see if there are any issues or delays that need to be addressed.
The finalized (FIN) status will only show once the order has departed the warehouse and will no longer receive line level changes.
Example of a finalized warehouse order with capture release serial numbers and packing information
{
"data": {
"id": "6434c71edd3283f909d1bd54",
"dateCreated": "2023-04-11T02:34:06+00:00",
"dateLastUpdated": "2023-04-11T02:55:29+00:00",
"status": "FIN",
"warehouseCode": "LAW",
"primaryReference": "123456789",
"secondaryReference": "SO000012345",
"shipToAddress": {
"address": {
"organization": "John Smith",
"addressLine1": "1234 Main Street",
"addressLine2": "",
"country": "USA",
"state": "CA",
"city": "Los Angeles",
"postalCode": "90012",
"isResidential": false
},
"contact": {
"personName": "John Smith",
"phoneNumber": "123-456-7890",
"mobileNumber": "",
"faxNumber": "",
"emailAddress": "john.smith@gmail.com"
}
},
"requiredShipDate": "2023-05-15T00:00:00+00:00",
"orderLines": [
{
"lineNumber": "1",
"externalLineReference": "001",
"productCode": "HP-SPX360-14-OLED-I7-16GB-1TB-NFBLK",
"quantity": 1,
"quantityUnit": "UNT",
"lineAttributes": [],
"lineCustomAttributes": [],
"partAttributes": []
}
],
"shipments": [
{
"id": "6434c720dd3283f909d1bd55",
"status": "FIN",
"dateCreated": "2023-04-11T02:34:08+00:00",
"dateLastUpdated": "2023-04-11T02:55:29+00:00",
"actualShipDate": "2023-04-11T02:55:16+00:00",
"trackingDetail": {
"carrierCode": "FEDEXPELS",
"serviceLevelCode": "",
"trackingNumber": "TRACK12345678"
},
"warehouseCode": "LAW",
"primaryReference": "123456789",
"secondaryReference": "SO000012345",
"shipToAddress": {
"address": {
"addressLine1": "1234 Main Street",
"addressLine2": "",
"country": "US",
"state": "CA",
"city": "Los Angeles",
"postalCode": "90012",
"isResidential": false
},
"contact": {
"personName": "John Smith",
"phoneNumber": "123-456-7890",
"emailAddress": "john.smith@gmail.com"
}
},
"requiredShipDate": "2023-05-14T12:00:00+00:00",
"totalCost": "0",
"totalCostUnit": "USD",
"packages": [
{
"packageReference": "123456789-001",
"weight": 7.950,
"weightUnit": "LB",
"length": 14.000,
"width": 5.000,
"height": 0.800,
"dimUnit": "IN",
"packageType": "BOX",
"packedLines": [
{
"quantity": 1.000,
"orderLineReference": "1",
"orderSubLineReference": "0",
"productCode": "HP-SPX360-14-OLED-I7-16GB-1TB-NFBLK"
}
]
}
],
"shipmentLines": [
{
"sublines": [
{
"quantity": 1.000,
"partAttributes": [
{
"key": "Serial Number",
"value": "123456789"
}
]
}
],
"lineNumber": "1",
"externalLineReference": "001",
"productCode": "HP-SPX360-14-OLED-I7-16GB-1TB-NFBLK",
"quantity": 1.000,
"quantityUnit": "UNT",
"lineAttributes": [],
"lineCustomAttributes": [],
"partAttributes": [
{
"key": "SERIAL NUMBER",
"value": "123456789"
}
]
}
],
"milestones": [
{
"code": "WHE",
"description": "Entered",
"sequence": "1",
"actualDate": "2023-04-11T02:34:08+00:00"
},
{
"code": "WHI",
"description": "Sent to Pick",
"sequence": "2",
"actualDate": "2023-04-11T02:47:54+00:00"
},
{
"code": "FIN",
"description": "Finalized",
"sequence": "3",
"actualDate": "2023-04-11T02:55:16+00:00"
}
],
"additionalReferences": [
{
"key": "ORD",
"value": "ACME1234"
}
]
}
],
"additionalReferences": [
{
"key": "ORD",
"value": "ACME1234"
}
],
"note": "BEST RATE - FEDEX OR UPS - 2DAY"
},
"id": "fb37dfb3ed5742e4a66053467ea2b199",
"resource": [],
"errors": []
}