Overview
Receives
The Warehouse API Receives endpoint is used to instruct the warehouse of inbound shipments that will be received into inventory. This may align with upstream system's definition of a Purchase Order or Advanced Shipment Notice.
Example of a finalized warehouse receive
{
"data": {
"receives": [
{
"id": "677eddd7813921e226061966",
"dateCreated": "2025-01-08T20:19:35+00:00",
"dateLastUpdated": "2025-01-09T22:21:56+00:00",
"warehouseCode": "LAW",
"primaryReference": "123456789",
"secondaryReference": "194227",
"status": "FIN",
"jobCosting": {},
"transportDetail": {},
"receiveLines": [
{
"lineNumber": "1",
"productCode": "Product 1",
"quantity": 1344,
"quantityUnit": "UNT",
"lineAttributes": [],
"lineCustomAttributes": [],
"partAttributes": []
},
{
"lineNumber": "2",
"productCode": "Product 2",
"quantity": 160,
"quantityUnit": "UNT",
"lineAttributes": [],
"lineCustomAttributes": [],
"partAttributes": []
}
],
"additionalReferences": [
{
"key": "CUS",
"value": "Ex Cus"
}
],
"shipments": [
{
"id": "677eddd8813921e226061986",
"wmsDocketId": "W01558600",
"dateCreated": "2025-01-08T20:19:36+00:00",
"dateLastUpdated": "2025-01-09T22:21:56+00:00",
"warehouseCode": "LAW",
"primaryReference": "123456789",
"secondaryReference": "194227",
"status": "FIN",
"arrivalDate": "2025-01-09T14:23:00+00:00",
"totalQuantity": 1504.000,
"transportReference": "",
"receiveLines": [
{
"sublines": [],
"lineNumber": "1",
"productCode": "Product 1",
"quantity": 1344.000,
"quantityUnit": "UNT",
"lineAttributes": [],
"lineCustomAttributes": [],
"holdCode": "",
"partAttributes": [],
"palletId": ""
},
{
"sublines": [],
"lineNumber": "2",
"productCode": "Product 2",
"quantity": 160.000,
"quantityUnit": "UNT",
"lineAttributes": [],
"lineCustomAttributes": [],
"holdCode": "",
"partAttributes": [],
"palletId": ""
}
],
"additionalReferences": [
{
"key": "CUS",
"value": "Ex Cus"
}
],
"milestones": [
{
"code": "WHE",
"description": "Created",
"sequence": "1",
"actualDate": "2025-01-08T20:19:38+00:00"
},
{
"code": "FIN",
"description": "Finalized",
"sequence": "6",
"actualDate": "2025-01-09T15:25:01+00:00"
}
],
"jobCosting": {
"branch": "ER3"
},
"serviceLevel": "",
"subType": "REC"
}
],
"tags": [],
"additionalNotes": []
}
]
},
"id": "76d5e52d-3f1e-40f6-b09d-362352ffc2a3",
"resource": [],
"errors": []
}
Understanding Receive Shipments
A receive can consist of one or more shipments, which are collections of receive lines associated with the receive. The receive has three primary statuses: processing (PRS), finalized (FIN), and canceled (CAN). When you submit a receive to the API and it passes validation, the receive will immediately be in the processing status. The receive will remain in the processing status until all shipments are either finalized or canceled. Once the receive is finalized, it confirms that the warehouse has physically received into inventory all of the receive lines listed under the related shipment.
The shipments list is a crucial part of each receive. It is a collection of shipments associated with a specific receive, and you can assume that one receive will have one shipment unless instructed otherwise by your Logistics Plus representative. The receive lines represent what is supposed to arrive at the warehouse, while the shipment represents what actually arrived at the warehouse. This allows you to easily determine if the receive was received in full, short, or over.
Each shipment has a status that can be one of the following:
- ENT: Entered
- PUT: Putting Away
- FIN: Finalized
- CAN: Canceled
Understanding the shipments list and the status of each shipment is critical to tracking the progress of your receive. By checking the status of each shipment, you can see if there are any issues or delays that need to be addressed.
When all shipments related to a receive are finalized, the receive itself will also be finalized. The same can be assumed for cancellation.