Customer Pickup Details
URI Summary
POST /stores/{storeId}/nodes/{nodeId}/customerPickUps/{fulfillmentOrderId}
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 |
|
Query |
fulfillmentOrderId |
The fulfillmentOrderId for which to retrieve PickUp information |
yes |
String |
foid1234 |
Request Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
StoreId |
yes |
The seller organization at which fulfillment order belongs. |
|
NodeId |
yes |
Fulfillment Order Ship Node |
|
FulfillmentOrderId |
yes |
Unique number associated with Fulfillment Order |
Request Payload Example
Responses
|
Http Status Code |
Description |
|---|---|
|
200 |
Customer pickup details returned |
Response Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
customerPickUpDetails{ |
yes |
Fulfillment Order Details |
|
fulfillmentOrderId |
yes |
The fulfillment Order Id |
|
nodeId |
yes |
Fulfillment Order Ship Node |
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
webOrderId |
yes |
The original order id from the webstore |
|
omsOrderId |
yes |
Order ID assigned by the OMS |
|
orderDate |
yes |
order creation Date |
|
currency |
yes |
Currency of the order, e.g. EUR or USD |
|
holdLocation |
yes |
Hold Location of the line item in a store sales floor or backroom |
|
totalCustomerPickQuantity |
no |
Total quantity picked |
|
pinNumber |
no |
If PIN number feature is configured |
|
customerPickUpItems[{ |
yes |
Fulfillment OrderLine Details Min Occur :1 Max Occur: Many |
|
id |
yes |
An indentifier assigned for this pickup, e.g. 1. |
|
webLineId |
yes |
The order line number |
|
itemId |
yes |
The identifier for the item, including catalog number |
|
itemDesc |
yes |
Item Description |
|
upcs[{ |
yes |
UPCs on this item |
|
type |
yes |
This field can be ignored |
|
value |
yes |
The value of this UPC |
|
orderedQuantity |
yes |
The original order quantity |
|
pickedQuantity |
yes |
The quantity picked by the associate |
|
customerPickedQuantity |
no |
Quantity picked up by the customer |
|
canceledQuantity |
no |
Quantity not picked up by the customer |
|
cancellationReasonCode |
no |
Why did the customer not pick up? |
|
customAttributes{[ |
no |
Client specific customization |
|
name |
no |
Client specific customization |
|
value |
no |
Client specific customization |
|
destinations[{ |
yes |
Billing and shipping for this fulfillment order |
|
destinationId |
yes |
Cross referenced below |
|
destinationType |
yes |
MAILING_ADDRESS or SHIPPING_ADDRESS |
|
personName{ |
yes |
Person billed or picking up depending on cross reference |
|
firstName |
yes |
First name |
|
middleName |
no |
Middle name |
|
lastName |
no |
Last name |
|
phone |
no |
Phone number for person |
|
address{ |
yes |
Address for person or store |
|
line1 |
yes |
First line of address |
|
line2 |
no |
Second line of address |
|
city |
yes |
City |
|
mainDivisionCode |
yes |
State, Province, etc. |
|
postalCode |
yes |
Postal Code (zip code in the US) |
|
countryCode |
yes |
Country (e.g. DE, US) |
|
|
yes |
Email for this person |
|
billToAddress{ |
yes |
Cross reference to the destinationId above for the customer’s information and billing address |
|
destinationId |
yes |
|
|
shippingAddress |
yes |
Cross reference to the destinationId above for the store address and the person who will be picking up |
|
destinationId |
yes |
|
Response Payload Example
{
{
"customerPickUpDetails": {
"fulfillmentOrderId": "100052362714001",
"storeId": "TMSUS",
"nodeId": "TMS_NA-Store1",
"webOrderId": "0002614565823753",
"omsOrderId": "100052362714",
"orderDate": "2021-11-24T18:47:34+00:00",
"currency": "USD",
"holdLocation": "Loc1-123",
"totalCustomerPickQuantity": 5,
"pinNumber" : 7298,
"customerPickUpItems": [
{
"id": "1",
"webLineId": "1",
"itemId": "21-ISPUProd01",
"itemDesc": "Black Tennis Shoes",
"upcs": [
{
"type": "P",
"value": "355470307"
}
],
"orderedQuantity": 4,
"pickedQuantity": 2,
"customerPickedQuantity": 1,
"canceledQuantity": 3,
"cancellationReasonCode": "IPD",
"customAttributes": [
{
"key": "PIN_NUMBER",
"value": "M1EA0"
}
]
},
{
"id": "2",
"webLineId": "2",
"itemId": "21-ISPUProd02",
"itemDesc": "Black Tennis Shoes",
"upcs": [
{
"type": "P",
"value": "355470306"
}
],
"orderedQuantity": 5,
"pickedQuantity": 3,
"customerPickedQuantity": 2,
"canceledQuantity": 3,
"cancellationReasonCode": "IPD",
"customAttributes": [
{
"key": "PIN_NUMBER",
"value": "M1EA0"
}
]
}
],
"destinations": [
{
"destinationId": "billing_1",
"destinationType": "MAILING_ADDRESS",
"personName": {
"firstName": "Richard",
"lastName": "Doyle"
},
"phone": "1111111111",
"address": {
"line1": "801 Hat Trick Avenue",
"city": "Eveleth",
"mainDivisionCode": "MN",
"countryCode": "US"
},
"email": "RadialNRFCustomer1@gmail.com"
},
{
"destinationId": "shipping_1",
"destinationType": "SHIPPING_ADDRESS",
"personName": {
"firstName": "Richard",
"lastName": "Doyle"
},
"address": {
"line1": "SOUTHSIDE SHOPPING CTR",
"line2": "2000 WHARTON ST STE A",
"city": "PITTSBURGH",
"mainDivisionCode": "PA",
"postalCode": "15203",
"countryCode": "US"
},
"email": "4373wm1@rsonline.gsicommerce.com"
}
],
"billToAddress": {
"destinationId": "billing_1"
},
"shippingAddress": {
"destinationId": "shipping_1"
}
}
}