Putaway Summary

URI Summary

POST /stores/{storeId}/nodes/{nodeId}/putAway/search

Request Parameters

Parameter Type	Name	Description	Required	Definition	Example
Path	storeId	The store identifier	yes	String	TMSUS
Path	nodeId	The node identifier	yes	String	TMS_NA-Store001

Request Payload Definition

Element	Required	Description
storeId	yes	The seller organization at which fulfillment order belongs.
nodeId	yes	The node identifier
putAwayLocation	no	Limit response to specified putaway location
stagingLocation	no	Limit response to the specified staging location
itemId	no	Limit response to the specified Item id with catalog number
pageId	no	Return one particular page of output
pageSize	no	Page size if asking for output by page number
lastPageId	no	Last page number in case list is shown in pages
maxRecordsCount	no	Maximum number of records to return
lastRecordId	no	Fulfillment Order unique Key for pagination support

Request Payload Example

Copy

{
    "storeId": "TMS_US",
    "nodeId": "TMS_NA-Store123",
    "putAwayLocation": "X1-03-05",
    "stagingLocation": "NX-01-61",
    "itemId": "21-ATCGBGF59030002",
    "pageId" : 3,    
    "pageSize" : 50,
    "lastPageId" : 2,
    "maxRecordsCount" : 100,
    "lastRecordId" : 100
 }

Responses

Http Status Code	Description
200	PutAwaySummaryResponse

Response Payload Definition

Element	Required	Description
storeId	yes	The seller organization at which fulfillment order belongs.
nodeId	yes	The node identifier
pageId	no	If paging was requested
pageSize	no	If paging was requested
putAwayItems[{	no
putAwayItemId	yes	Internal ID, can be ignored
itemId	yes	Item id with catalog number
itemDesc	yes	Description of item
quantity	yes	Quantity to be put away
putAwayLocation	yes	Where items are to be put away
stagingLocation	yes	Where items are now
upcs[{	yes	UPCs on this item
type	yes	This field can be ignored
value	yes	UPC code itself

Response Payload Example

Copy

{
    "storeId": "TMS_US",
    "nodeId": "TMS_NA-DC00",
    "pageId":3,  
    "pageSize":50,
    "putAwayItems": [
        {
            "putAwayItemId": "201706110232113",
            "itemId": "21-ATCGBGF59030002",
            "itemDesc": "Item Desc1",
            "quantity": 2,
            "putAwayLocation": "X1-03-05",
            "stagingLocation": "NX-01-61",
            "upcs": [
                {
                    "type": "G",
                    "value": "00067901292941"
                },
                {
                    "type": "E",
                    "value": "00067901292942"
                }
            ]
        },
        {
            "putAwayItemId": "201706110232114",
            "itemId": "21-ATCGBGF59030003",
            "itemDesc": "Item Desc2",
            "quantity": 5,
            "putAwayLocation": "ZK-03-87",
            "stagingLocation": "XY-01-85",
            "upcs": [
                {
                    "type": "G",
                    "value": "00067901292941"
                },
                {
                    "type": "E",
                    "value": "00067901292942"
                }
            ]
        },
        {
            "putAwayItemId": "201706110232115",
            "itemId": "21-ATCGBGF59030004",
            "itemDesc": "Item Desc3",
            "quantity": 8,
            "putAwayLocation": "",
            "stagingLocation": "",
            "upcs": []
        }
    ]
}