Check-In Details
This endpoint support the Ship-to Store fulfillment type.
URI Summary
GET /stores/{storeId}/nodes/{nodeId}/fulfillmentOrders/{fulfillmentOrderId}/checkin
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 |
|
Path |
fulfillmentOrderId |
Unique number associated with Fulfillment Order |
yes |
String |
100051718744001 |
Responses
|
Http Status Code |
Description |
|---|---|
|
200 |
FulfillmentOrderCheckInPackagesDetailsResponse |
|
400 |
Bad Request |
|
404 |
Not Found |
|
500 |
Internal Server Error |
Response Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
fulfillmentOrder{ |
yes |
Fulfillment Order Details |
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
nodeId |
yes |
Fulfillment Order Ship Node |
|
omsOrderId |
yes |
Order ID assigned by the OMS |
|
fulfillmentOrderId |
yes |
The fulfillment Order Id |
|
webOrderId |
yes |
The original order id from the webstore |
|
fulfillmentType |
yes |
SHIP_TO_STORE |
|
currency |
yes |
Currency of the order, e.g. EUR or USD |
|
carrier |
yes |
The carrier portion of the SCAC. Values will vary per client. |
|
service |
yes |
The service portion of the SCAC. Values will vary per client. |
|
fulfillmentOrderDate |
yes |
Date fulfillment order was generated |
|
orderDate |
yes |
order creation Date |
|
totalVolume{ |
yes |
|
|
unit |
yes |
|
|
value |
yes |
|
|
totalWeight{ |
yes |
|
|
unit |
yes |
|
|
value |
yes |
|
|
holdLocation |
no |
This will only be set if Check-In Details is called after Check-In Confirm |
|
checkInPackages[{ |
yes |
Packages for this fulfillment order |
|
checkInPackageId |
yes |
Internal identifier for this package. |
|
trackingNumber |
yes |
Carrier tracking number on package |
|
checkInPackageItems[{ |
yes |
The items in this package |
|
itemId |
yes |
Full item ID with catalog number |
|
webLineId |
yes |
Line number on the original web order |
|
quantity |
yes |
How many are supposed to be in the package? |
|
checkInQuantity |
yes |
Ignore if calling before Check-In Confirm |
|
checkInCanceledQuantity |
yes |
Ignore if calling before Check-In Confirm |
|
checkInCancellationReasonCode |
no |
Required if the canceled quantity is > 0 |
|
destinations[{ |
yes |
Billing and shipping for this fulfillment order |
|
destinationId |
yes |
Cross referenced below |
|
destinationType |
yes |
MAILING_ADDRESS, SHIPPING_ADDRESS or NODE_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 |
|
|
shipFromAddress |
yes |
Cross reference to the destinationId above for where the package shipped from |
|
destinationId |
yes |
|
Response Payload Example
{
"fulfillmentOrder": {
"storeId": "TMSUS",
"nodeId": "TMS_NA-Store1",
"omsOrderId": "100051718744",
"fulfillmentOrderId": "100051718744001",
"webOrderId": "0008025255225581",
"fulfillmentType": "SHIP_TO_HOME",
"currency": "USD",
"carrier": "ISPU",
"service": "ISPU",
"fulfillmentOrderDate": "2021-09-29T22:25:50+00:00",
"orderDate": "2021-09-29T22:25:28+00:00",
"totalVolume": {
"unit": "CIN",
"value": 1326.924
},
"totalWeight": {
"unit": "LBS",
"value": 26.22
},
"holdLocation": "Loc1-123",
"checkInPackages": [{
"checkInPackageId": "100131671",
"trackingNumber": "1Z11111991100",
"checkInPackageItems": [{
"itemId": "21-ISPUProd01",
"webLineId": "1",
"quantity": 3,
"checkInQuantity": 2,
"checkInCanceledQuantity": 1,
"checkInCancellationReasonCode": "IDD"
}]
}],
"destinations": [{
"destinationId": "billing_1",
"destinationType": "MAILING_ADDRESS",
"personName": {
"firstName": "Joe",
"lastName": "Minimum"
},
"phone": "2155551212",
"address": {
"line1": "630 allendale road",
"city": "King Of Prussia",
"mainDivisionCode": "PA",
"postalCode": "19406",
"countryCode": "US"
},
"email": "RIT_E2E_240_LogPro@dashboard.gsi"
},
{
"destinationId": "shipping_1",
"destinationType": "SHIPPING_ADDRESS",
"personName": {
"firstName": "Model",
"lastName": "Store2"
},
"phone": "7410852963",
"address": {
"line1": "935 First Ave",
"line2": "",
"city": "King Of Prussia",
"mainDivisionCode": "PA",
"postalCode": "19406",
"countryCode": "US"
},
"email": "RIT_E2E_240_LogPro@dashboard.gsi"
},
{
"destinationId": "shipFrom_1",
"destinationType": "NODE_ADDRESS",
"personName": {
"firstName": "Model",
"lastName": "Store1"
},
"phone": "7410852963",
"address": {
"line1": "630 Allendale",
"line2": "",
"city": "King Of Prussia",
"mainDivisionCode": "PA",
"postalCode": "19406",
"countryCode": "US"
}
}
],
"billToAddress": {
"destinationId": "billing_1"
},
"shippingAddress": {
"destinationId": "shipping_1"
},
"shipFromAddress": {
"destinationId": "shipFrom_1"
}
}
}