Pick Ticket Summary
POST /stores/{storeId}/nodes/{nodeId}/pickTicket/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 |
Fulfillment Order Ship Node |
|
queueId |
yes |
Queue the order is already on |
|
userId |
yes |
Login ID of the ROM UI user |
|
pickTicket{ |
no |
The fulfillment order ids to be picked |
|
pickTicketId |
no |
Seach for a specific ticket |
|
fulfillmentTypes[ |
no |
This is not useful for ISPU only |
|
pickTicketDateRange{ |
no |
Search by ticket date range |
|
from |
yes |
|
|
to |
yes |
|
|
pickSLADateRange{ |
no |
Search by SLA date range |
|
from |
yes |
|
|
to |
yes |
|
|
Statuses[ |
yes |
Search by NEW, IN_PROGRESS and/or CLOSED |
|
pageId |
yes |
Page number in case result list is shown in pages |
|
PageSize |
yes |
Page Size in case result list is shown in pages |
|
maxRecordsCount |
no |
Maximum number of Fulfillment records to be retrieved. |
Request Payload Example
{
"storeId": "TMS_US",
"nodeId": "TMS_NA-DC001",
"queueId": "QUE-123",
"userId": "UserId001",
"pickTicket": {
"pickTicketId": "1234",
"fulfillmentTypes": [
"STORE_PICK_UP",
"SHIP_TO_HOME"
],
"pickTicketDateRange": {
"from": "2014-10-04T15:00:00+00:00",
"to": "2014-11-04T15:00:00+00:00"
},
"pickSLADateRange": {
"from": "2014-10-04T15:00:00+00:00",
"to": "2014-11-04T15:00:00+00:00"
},
"statuses": [
"NEW",
"IN_PROGRESS"
]
},
"pageId": 3,
"pageSize": 50,
"lastPageId": 2,
"maxRecordsCount": 100,
"lastRecordId": 100
}
Responses
|
Http Status Code |
Description |
|---|---|
|
200 |
Pick Ticket Summary Response |
Response Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
pickTickets[{ |
yes |
|
|
pickTicketId |
yes |
The ID of this ticket |
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
nodeId |
yes |
Fulfillment Order Ship Node |
|
queueId |
yes |
Queue the order is already on |
|
userId |
yes |
Login ID of the ROM UI user |
|
status |
yes |
NEW or IN_PROGRESS or CLOSED |
|
fulfillmentType |
yes |
Always STORE_PICK_UP for ISPU |
|
pickTicketDate |
yes |
Date/time ticket was created |
|
pickSLADate |
yes |
Date/time ticket is due |
|
totalFulfillmentOrders |
yes |
Number of orders on this pick ticket (typically 1 for ISPU) |
|
totalSKUs |
yes |
Number of SKUs on this ticket |
|
totalQuantity |
yes |
Total number of items to be picked |
|
pageId |
yes |
Page we are on if response spans pages |
|
pageSize |
yes |
Number of tickets per page |
Response Payload Example
{
"pickTickets": [
{
"pickTicketId": "23412",
"storeId": "TMS_US",
"nodeId": "TMS_NA-DC001",
"queueId": "QUE-123",
"userId": "UserId001",
"status": "NEW",
"fulfillmentType": "STORE_PICK_UP",
"pickTicketDate": "2015-11-04T15:00:00",
"pickSLADate": "2015-11-04T15:00:00",
"totalFulfillmentOrders": 3,
"totalSKUs": 3,
"totalQuantity": 2
},
{
"pickTicketId": "23414",
"storeId": "TMS_US",
"nodeId": "TMS_NA-DC001",
"queueId": "QUE-123",
"userId": "UserId001",
"status": "ASSIGNED",
"fulfillmentType": "STORE_PICK_UP",
"pickTicketType": "ISPU_PICK",
"pickTicketDate": "2015-11-04T15:00:00",
"pickSLADate": "2015-11-04T15:00:00",
"totalFulfillmentOrders": 3,
"totalSKUs": 3,
"totalQuantity": 2
}
],
"pageId" : 3,
"pageSize" : 50
}