Pick Ticket Generate
POST /stores/{storeId}/nodes/{nodeId}/pickTicket/generate
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 |
fulfillmentOrderIds[ |
yes |
The fulfillment order ids to be picked |
modifyAssociateId |
yes |
The associate making the request. Will need to determine how ELC is using this field. |
Request Payload Example
{
"storeId": "TMS_US",
"nodeId": "TMS_NA-DC001",
"queueId": "QUE-123",
"userId": "UserId001",
"fulfillmentOrderIds": [
"25255225581001"
],
"modifyAssociateId": "associate_id"
}
Responses
Http Status Code |
Description |
---|---|
201 |
Pick Ticket Generated Response |
Response Payload Definition
Element |
Required |
Description |
---|---|---|
pickTicketDetails |
yes |
|
pickTicketId |
yes |
The pick ticket identifier |
storeId |
yes |
The seller organization to which this fulfillment order belongs. |
nodeId |
yes |
The node to which this order belongs |
queueId |
yes |
Queue the order is already on |
userId |
yes |
Login ID of the ROM UI user |
status |
yes |
NEW |
holdLocation |
yes |
Where to place the item once picked |
fulfillmentType |
yes |
Will always be same for ISPU |
pickTicketType |
yes |
PICK_TICKET |
pickTicketDate |
yes |
When the pick ticket was generated |
pickSLADate |
yes |
When the ticket should be picked by |
currency |
yes |
The currency code in which this order is being processed, e.g. EUR or USD. |
totalFulfillmentOrders |
yes |
Number of fulfillment orders on this pick ticket |
totalSKUs |
yes |
Number of SKUs on this pick ticket |
totalQuantity |
yes |
Total number of items to be picked |
pickTicketItems[{ |
yes |
|
id |
yes |
Sequential id number assigned for this ticket (1-n) |
itemDetails{ |
yes |
|
itemId |
yes |
The identifier for the item, including catalog |
itemDesc |
yes |
The description of the item. |
color |
yes |
Color description |
colorCode |
yes |
Color code |
size |
yes |
Size description |
sizeCode |
yes |
Size code |
style |
yes |
|
upcs[{ |
yes |
UPCs on this item |
type |
yes |
This field can be ignored |
value |
yes |
The value of this UPC |
quantity |
yes |
Quantity to be picked |
unitPrice |
yes |
Price of one item |
retailPrice |
no |
Retail store price at this node. Only set > 0 if included in the NodeItem feed. |
pickLocation |
no |
Set if included in node/item feed |
pickedQuantity |
no |
Should be not present or 0 for a newly generated ticket |
canceledQuantity |
no |
Should be not present or 0 for a newly generated ticket |
cancellationReasonCode |
no |
Should be not present or empty unless canceledQuantity > 0 |
Response Payload Example
{
"pickTicketDetails": [
{
"pickTicketId": "12321312",
"storeId": "TMS_US",
"nodeId": "TMS_NA-DC001",
"queueId": "QUE-123",
"userId": "UserId001",
"status": "NEW",
"holdLocation": "Loc1-123",
"fulfillmentType": "STORE_PICK_UP",
"pickTicketType": "PICK_TICKET",
"pickTicketDate": "2015-11-04T15:00:00",
"pickSLADate": "2021-05-09T19:16:59+00:00",
"currency": "USD",
"totalFulfillmentOrders": 3,
"totalSKUs": 3,
"totalQuantity": 2,
"pickTicketItems": [
{
"id": "43434",
"itemDetails": {
"itemId": "21-885641458409",
"itemDesc": "10360 6 PREM RUST NBK-WP",
"color": "Brown",
"colorCode": "700",
"size": "06-Extra Large",
"sizeCode": "06-XL",
"style": "123-L",
"upcs": [
"00067901292941",
"00067901292942"
]
},
"quantity": 1,
"unitPrice": 20,
"retailPrice": 19,
"pickLocation": "Loc2-1234",
"pickedQuantity": 1,
"canceledQuantity": 1,
"cancellationReasonCode": "IPD"
},
{
"id": "43435",
"itemDetails": {
"itemId": "21-885641458410",
"itemDesc": "10360 6 PREM RUST NBK-WP",
"color": "CHK",
"colorCode": "700",
"size": "06-Extra Large",
"sizeCode": "06-XL",
"style": "123-L",
"upcs": [
"00067901292941",
"00067901292942"
]
},
"quantity": 2,
"unitPrice": 20,
"retailPrice": 19,
"pickLocation": "Loc2-1234",
"pickedQuantity": 1,
"canceledQuantity": 1,
"cancellationReasonCode": "IPD"
}
]
}
]
}