Inbound List RNs API
Inbound List RNs API is used to retrieve a list of inbound receipt notifications in WMS. This article introduces the general Inbound List RNs API for easily understanding and applying this API.
Introduction
Inbound List RNs API allows users to access information regarding received goods, enabling them to track incoming shipments efficiently. This API is essential for maintaining up-to-date records of all received items, ensuring smooth operations in inventory management.
API Request
API: POST /edi/3pl/inbound/receipt/list
Body Request:
Body Parameter | Required | Description | Note |
---|---|---|---|
CompanyID | Y | Company ID | "LT" |
FacilityID | Y | Facility ID | "889" |
CustomerID | Y | Customer ID | "AUKINT0001" |
PONo | N | PO Number | "8957515451-10" |
ReferenceNo | N | Reference Number | "LIV2020021804-10" |
Status | N | Receipt Status | Imported, Closed, Cancelled |
CreatedWhenFrom | N | Created Date From | "2022-02-01T00:00:00-08:00" |
CreatedWhenTo | N | Created Date To | "2022-02-03T00:00:00-08:00" |
UpdatedWhenFrom | N | Updated Date From | "2022-02-01T00:00:00-08:00" |
UpdatedWhenTo | N | Updated Date To | "2022-02-03T00:00:00-08:00" |
Paging | N | Page Object | "PageNo": 1 |
API Return
It returns the receipt list with the detailed data, for more detail, please refer to the following example.
Example
Request
{
"CompanyID": "LT",
"CustomerID": "AUKINT0001",
"FacilityID": "889",
"PONo": "",
"ReferenceNo": "",
"Status": "Imported",
"CreatedWhenFrom": "2022-03-01T00:00:00.000Z",
"CreatedWhenTo": "2022-03-31T00:00:00.000Z",
"UpdatedWhenFrom": "",
"UpdatedWhenTo": "",
"Paging":{
"PagingNo":1
}
}
Response
// Success return
200
{
"Receipts": [{
"FacilityID": "889",
"ReceiptID": "RN-11",
"ReferenceNo": "011303",
"ReceiptType": "Internal Transfer Receiving",
"TitleID": "ABCD",
"CreatedWhen": "2023-01-13T02:12:25.251",
"CarrierName": "ABCD",
"Status": "Imported"
},
{
"FacilityID": "889",
"ReceiptID": "RN-10",
"ReferenceNo": "186383",
"PONo": "TESTCU0",
"TitleID": "ABCD",
"CreatedWhen": "2023-01-11T09:18:51.742",
"UpdatedWhen": "2023-01-11T10:14:01.092",
"BOLNo": "B22100",
"ContainerNo": "TCLU5333333",
"CarrierName": "CARRIER TRUCKER",
"Status": "Closed",
"DynTxtPropertyValue01": "3293",
"DynTxtPropertyValue02": "S202",
"DynTxtPropertyValue03": "AMAZON"
}
],
"Paging": {
"PageNo": 1,
"TotalCount": 2,
"TotalPage": 1,
"Limit": 10
}
}
// Failure return
400
{
"error": "something went wrong"
}