Customer Pickup Receipt
URI Summary
POST /stores/{storeId}/nodes/{nodeId}/customerPickUp/receipts/{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 Receipt 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 receipt details returned |
Response Payload Definition
Element |
Required |
Description |
---|---|---|
customerPickUpReceipt{ |
yes |
|
customerReceiptId |
yes |
Receipt Number |
customerPickupDetails{ |
yes |
|
fulfillmentOrderId |
yes |
Unique number associated with Fulfillment Order |
omsOrderId |
yes |
OMS Order Number |
webOrderId |
yes |
Customer Webstore order number |
orderDate |
yes |
Webstore Order Creation Date |
storeId |
yes |
The webstore or seller that this order is for |
nodeId |
yes |
The node id of the physical stire |
fulfillmentType |
yes |
The value of this field will depend on the queue the order is in, and can usually be ignored. For this call it should always be “STORE_PICK_UP” or “SHIP_TO_STORE” |
currency |
yes |
The currency code in which this order is being processed, e.g. EUR or USD. |
totalAmountBreakDown{ |
yes |
|
merchandise |
yes |
Total merchandise amount |
charges |
yes |
Total additional charges |
discounts |
yes |
Total order-level discounts subtracted |
taxes |
yes |
Total taxes added |
total |
yes |
Merchandise + charges – discounts + taxes |
customerPickUpItems[{ |
yes |
|
webLineId |
yes |
The line number on the original order |
id |
yes |
An assigned identifier for this pickup, 1, 2, 3, etc. |
itemId |
yes |
Item ID, including the catalog number |
itemDesc |
yes |
Item Description |
orderedQuantity |
yes |
The original order quantity |
pickedQuantity |
yes |
The quantity picked by the associate |
customerPickedQuantity |
no |
Quantity picked up by the customer |
pickCanceledQuantity |
no |
Quantity not picked up by the associate |
pickCancellationReasonCode |
no |
Why did the associate not pick up? |
customerPickCanceledQuantity |
no |
Quantity not picked up by the customer |
customerPickCancelReasonCode |
no |
Why did the customer not pick up? |
upcs[{ |
yes |
UPCs on this item |
type |
yes |
This field can be ignored |
value |
yes |
The value of this UPC |
totalItemBreadkdown{ |
yes |
|
merchandise |
yes |
merchandise amount |
charges |
yes |
additional charges |
discounts |
yes |
discounts subtracted |
taxes |
yes |
taxes added |
total |
yes |
Merchandise + charges – discounts + taxes |
payments[{ |
yes |
|
creditCardExpDate |
no |
Credit Card expiration date (if credit card) |
paymentType |
yes |
Payment Type, e.g. CC |
creditCardName |
yes |
Name on credit card |
creditCardType |
yes |
Type of credit card |
creditCardNo |
yes |
Not full unprotected PAN |
destinations[{ |
yes |
Billing and shipping for this fulfillment order |
destinationId |
yes |
Cross referenced below |
destinationType |
yes |
MAILING_ADDRESS |
personName{ |
yes |
Customer name |
firstName |
yes |
First name |
middleName |
no |
Middle name |
lastName |
no |
Last name |
phone |
no |
Customer phone number |
address{ |
yes |
Customer address |
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 |
Customer email |
billToAddress{ |
yes |
Cross reference to the destinationId above for the customer’s information and billing address |
destinationId |
yes |
|
Return[{ |
no |
For in store returns |
returnOrderId |
yes |
Order Id for the return |
totalAmountBreakDown{ |
yes |
|
merchandise |
yes |
Total merchandise amount |
charges |
yes |
Total additional charges |
discounts |
yes |
Total order-level discounts subtracted |
taxes |
yes |
Total taxes added |
total |
yes |
Merchandise + charges – discounts + taxes |
orderItems[{ |
yes |
All of the items returned |
webLineId |
yes |
The line number on the original order |
id |
yes |
An assigned identifier for this return: 1, 2, 3, etc. |
itemId |
yes |
Item ID, including the catalog number |
itemDesc |
yes |
Item Description |
quantity |
yes |
The quantity returned |
totalItemBreadkdown{ |
yes |
|
merchandise |
yes |
merchandise amount |
charges |
yes |
additional charges |
discounts |
yes |
discounts subtracted |
taxes |
yes |
taxes added |
total |
yes |
Merchandise + charges – discounts + taxes |
{
"customerPickUpReceipt": {
"customerReceiptId": "100015930",
"customerPickUpDetails": {
"fulfillmentOrderId": "100052171624001",
"omsOrderId": "100052171624",
"orderDate": "2021-09-11T03:50:52+00:00",
"storeId": "TMSUS",
"nodeId": "TMS_NA-Store1",
"fulfillmentType": "STORE_PICK_UP",
"currency": "USD",
"totalAmountBreakDown": {
"merchandise": 114,
"charges": 0,
"discounts": 0,
"taxes": 6.84,
"total": 120.84
},
"customerPickUpItems": [
{
"webLineId": "1",
"id": "1",
"itemId": "21-ISPUProd01",
"itemDesc": "Black Tennis Shoes",
"orderedQuantity": 1,
"pickedQuantity": 1,
"customerPickedQuantity": 1,
"pickCanceledQuantity": "0",
"pickCancellationReasonCode": "IPD",
"customerPickCanceledQuantity": "1",
"customerPickCancelReasonCode": "OOS",
"upcs": [
{
"type": "P",
"value": "355470307"
}
],
"totalItemBreakDown": {
"merchandise": 114,
"charges": 0,
"discounts": 0,
"taxes": 6.84,
"total": 120.84
}
}
],
"payments": [
{
"creditCardExpDate": "2021-12",
"paymentType": "CC",
"creditCardName": "HerbBrooks",
"creditCardType": "VS",
"creditCardNo": "411111vjOiXS1111"
}
],
"destinations": [
{
"destinationId": "billing_1",
"destinationType": "MAILING_ADDRESS",
"personName": {
"firstName": "Herb",
"lastName": "Brooks"
},
"phone": "1111111111",
"address": {
"line1": "801 Hat Trick Avenue",
"city": "Eveleth",
"mainDivisionCode": "MN",
"countryCode": "US"
},
"email": "RIT_E2E_240_LogPro@dashboard.gsi"
}
],
"billToAddress": {
"destinationId": "billing_1"
}
},
"return": {
"returnOrderId": "100052171634",
"totalAmountBreakDown": {
"merchandise": 114,
"charges": 0,
"discounts": 0,
"taxes": 6.84,
"total": 120.84
},
"orderItems": [
{
"webLineId": "1",
"id": "1",
"itemId": "21-ISPUProd01",
"itemDesc": "Black Tennis Shoes",
"quantity": 1,
"totalItemBreakDown": {
"merchandise": 114,
"charges": 0,
"discounts": 0,
"taxes": 6.84,
"total": 120.84
}
}
]
}
}
}