Customer Pickup Confirm
URI Summary
PUT /stores/{storeId}/nodes/{nodeId}/customerPickUp/confirm
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 |
|---|---|---|
|
modifyAssociatedId |
yes |
The associate handling the pickup confirm |
|
customerPickupDetails{ |
yes |
Parent for all remaining rows |
|
FulfillmentOrderId |
yes |
Unique number associated with Fulfillment Order |
|
nodeId |
yes |
Fulfillment Order Ship Node |
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
customerPickUpItems[{ |
yes |
Fulfillment OrderLine Details |
|
webLineId |
yes |
Line number on the original web order |
|
itemId |
yes |
Full item ID with catalog number |
|
customerPickedQuantity |
no |
Customer Pick Up quantity One of both of this and next field should be set. Recommendation is to always include and set to 0 if all are cancelled. |
|
canceledQuantity |
no |
Cancelled Quantity which customer declined to take One of both of this and next field should be set. Recommendation is to always include and set to 0 if all are picked |
|
cancellationReasonCode |
no |
Cancel Reason code CancelReasonCode is mandatory if CancelQuantity is present |
|
backroomPickedQuantity |
yes |
The quantity originally picked |
Request Payload Example
{
"modifyAssociateId": "associate_id",
"customerPickUpDetails": {
"fulfillmentOrderId": "100052183794001",
"storeId": "TMS_US",
"nodeId": "TMS_NA-Store1",
"customerPickUpItems": [
{
"webLineId": "1",
"itemId": "21-ISPUProd01",
"customerPickedQuantity": 1,
"canceledQuantity": 0,
"cancellationReasonCode": "IPD",
"backroomPickedQuantity": 1
}
]
}
}
Responses
|
Http Status Code |
Description |
|---|---|
|
204 |
PickUp confirm success, no payload |