Fulfillment Order Details
URI Summary
POST /stores/{storeId}/fulfillmentOrders/{fulfillmentOrderId}
Request Parameters
|
Parameter Type |
Name |
Description |
Required |
Definition |
Example |
|---|---|---|---|---|---|
|
Path |
storeId |
The store identifier |
yes |
String |
TMSUS |
|
Path |
fulfillmentOrderId |
The fulfillment order identifier |
yes |
String |
25255225581002 |
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 |
FulfillmentOrderSummaryResponse |
Response Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
fulfillmentOrder{ |
yes |
|
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
nodeId |
yes |
Fulfillment Order Ship Node |
|
omsOrderId |
yes |
Order ID assigned by the OMS |
|
webOrderId |
yes |
Sales Order web number |
|
fulfillmentOrderId |
yes |
Fulfillment Order ID |
|
FulfillmentType |
yes |
Fulfillment Type. Always STORE_PICK_UP for ISPU |
|
currency |
yes |
The currency code in which this order is being processed, e.g. EUR or USD. |
|
carrier |
yes |
Fulfillment Order carrierService |
|
service |
yes |
Fulfillment Order Shipping SCAC |
|
ShippingMethod |
yes |
Fulfillment Order Scac and Service |
|
fulfillmentOrderDate |
yes |
Fulfillment Order create Date |
|
orderDate |
yes |
Sales Order Create Date |
|
status |
yes |
Fulfillment Order status. See introduction. Subject to change. |
|
totalVolume{ |
yes |
The total volume of the Fulfillment Order Shipment. |
|
unit |
yes |
The unit of measure for the units of volume |
|
value |
yes |
Number of units of measure |
|
totalWeight{ |
yes |
The total weight of the Fulfillment Order Shipment. |
|
unit |
yes |
The unit of measure for the weight |
|
value |
yes |
Number of units of weight |
|
pickTicketId |
no |
Pick Ticket number assigned to fulfillment Order |
|
holdLocation |
no |
Hold location of the Fulfillment Order |
|
storeName |
yes |
Physical store this order is being processed in |
|
FulfillmentOrderItems [{ |
yes |
|
|
webLineId |
yes |
Line ID from the original web order |
|
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 |
|
upcs[{ |
yes |
UPCs on this item |
|
type |
yes |
This field can be ignored |
|
value |
yes |
The value of this UPC |
|
quantity |
yes |
Current quantity |
|
orderedQuantity |
yes |
The quantity of the line item that has been ordered |
|
pickedQuantity |
yes |
The quantity of the line item that has been picked |
|
pickCanceledQuantity |
yes |
Quantity not picked by the associate |
|
pickCancellationReasonCode |
no |
Why didn’t the associate pick the items? |
|
customerPickCanceledQuantity |
yes |
Quantity not picked up by the customer |
|
customerPickCancelReasonCode |
no |
Why didn’t the customer accept the items? |
|
customerPickedQuantity |
yes |
The quantity of the line item that the customer picked up |
|
itemTotal { |
yes |
|
|
unitPrice |
yes |
|
|
extendedPrice |
yes |
|
|
charges |
yes |
|
|
tax |
yes |
|
|
SLADates[{ |
no |
Configured SLA name value pairs. SLAs for states not yet reached |
|
slaTypeId |
yes |
|
|
value |
yes |
|
|
proxyPickupDetails{ |
no |
Proxy pickup Email |
|
id |
no |
proxyPickupAddress_1 |
|
relationship |
no |
e.g. “Friend” |
|
|
no |
Proxy pickup Email |
|
personName{ |
yes |
Proxy pickup Name |
|
firstName |
yes |
First name |
|
lastName |
yes |
Last name |
|
phone |
no |
Proxy pickup Phone Number |
|
address{ |
no |
|
|
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) |
|
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 |
|
|
shippingAddress{ |
yes |
Cross reference to the destinationId above for the store address and name of person who will be picking up |
|
destinationId |
yes |
|
|
shipFromAddress{ |
no |
Not useful for ISPU |
|
destinationId |
yes |
|
|
packages[{ |
yes |
No packages for ISPU, SFS and STS only. |
|
packageId |
yes |
Unique package id |
|
trackingNumber |
yes |
Carrier-assigned tracking number |
|
weight{ |
yes |
weight |
|
value |
yes |
|
|
unit |
yes |
|
|
length{ |
yes |
|
|
value |
yes |
|
|
unit |
yes |
|
|
width{ |
yes |
width |
|
value |
yes |
|
|
unit |
yes |
|
|
height{ |
yes |
height |
|
value |
yes |
|
|
unit |
yes |
|
|
packageItems[{ |
yes |
|
|
itemId |
yes |
Item Id including catalg number |
|
webLineId |
yes |
Line id from the original web order |
|
quantity |
yes |
The quantity of the item packed in this container |
|
serialNo |
no |
Serial number |
|
orderTotal{ |
yes |
|
|
grandTotal |
yes |
Whole order price |
|
grandTax |
yes |
Whole order tax |
|
grandCharges |
no |
Whole order charges |
Response Payload Example
{
{
"fulfillmentOrder": {
"storeId": "TMSUS",
"nodeId": "TMS_NA-Store1",
"omsOrderId": "100052362714",
"webOrderId": "0002614565823753",
"fulfillmentOrderId": "100052362714001",
"fulfillmentType": "STORE_PICK_UP",
"currency": "USD",
"carrier": "ISPU",
"service": "ISPU",
"fulfillmentOrderDate": "2021-11-24T18:47:53+00:00",
"orderDate": "2021-11-24T18:47:34+00:00",
"status": "1600.002",
"totalVolume": {
"unit": "CIN",
"value": 0.3051
},
"totalWeight": {
"unit": "LBS",
"value": 11.0231
},
"pickTicketId": "100015122",
"holdLocation": "Loc1-123",
"storeName": "PITTSBURGH-SOUTHSIDE SC",
"fulfillmentOrderItems": [
{
"webLineId": "1",
"itemDetails": {
"itemId": "21-ISPUProd01",
"itemDesc": "Black Tennis Shoes",
"color": "Brown",
"colorCode": "700",
"size": "6-M",
"sizeCode": "6-M",
"upcs": [
{
"type": "P",
"value": "355470307"
}
]
},
"quantity": 2,
"orderedQuantity": 2,
"pickedQuantity": 2,
"pickCanceledQuantity": 2,
"pickCancellationReasonCode": "IPD",
"customerPickCanceledQuantity": 1,
"customerPickCancelReasonCode" : "OOS",
"packCanceledQuantity": 0,
"packCancelReasonCode":"IPD",
"customerPickedQuantity": "1",
"itemTotal": {
"unitPrice": 114,
"extendedPrice": 228,
"charges": 0,
"tax": 15.96
}
},
{
"webLineId": "2",
"itemDetails": {
"itemId": "21-ISPUProd02",
"itemDesc": "Black Tennis Shoes",
"color": "Brown",
"colorCode": "700",
"size": "6-M",
"sizeCode": "6-M",
"hazmatIndicator": true
},
"quantity": 3,
"pickedQuantity": 3,
"pickCanceledQuantity": 2,
"pickCancellationReasonCode": "IPD",
"customerPickCanceledQuantity": 1,
"packCanceledQuantity": 0,
"customerPickedQuantity": "2",
"itemTotal": {
"unitPrice": 114,
"extendedPrice": 342,
"charges": 0,
"tax": 23.94
}
}
],
"slaDates": [
{
"slaTypeId": "BACKROOMPICK_APPROACHING"
},
{
"slaTypeId": "BACKROOMPICK_EXPIRED"
},
{
"slaTypeId": "CUSTOMERPICK_APPROACHING"
},
{
"slaTypeId": "CUSTOMERPICK_EXPIRED"
},
{
"slaTypeId": "PICKTICKETGENERATE_APPROACHING",
"value": "2021-11-24T18:57:53+00:00"
},
{
"slaTypeId": "PICKTICKETGENERATE_EXPIRED",
"value": "2021-11-24T19:17:53+00:00"
}
],
“proxyPickupDetails" : {
"id" : "proxyPickupAddress_1",
"relationship":"Friend"
"personName" : {
"firstName" : "Mary",
"lastName" : "Pickup"
},
"phone" : "5551231234",
"address" : {
"line1" : "200 Adams Rd",
"city" : "Harleysville",
"mainDivisionCode" : "PA",
"postalCode" : "19438",
"countryCode" : "US"
}
},
"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"
},
{
"destinationId": "shipFrom_1",
"destinationType": "NODE_ADDRESS",
"personName": {
},
"address": {
"line1": "630 Allendale",
"city": "King Of Prussia",
"mainDivisionCode": "PA",
"postalCode": "19406",
"countryCode": "US"
}
}
],
"billToAddress": {
"destinationId": "billing_1"
},
"shippingAddress": {
"destinationId": "shipping_1"
},
"shipFromAddress": {
"destinationId": "shipFrom_1"
},
"packages": [
{
"packageId": "100132194",
"trackingNumber": "100047839154001998",
"weight": {
"value": 0,
"unit": "LBS"
},
"length": {
"value": 1,
"unit": "IN"
},
"width": {
"value": 1,
"unit": "IN"
},
"height": {
"value": 1,
"unit": "IN"
},
"packageItems": [
{
"itemId": "36-5134180",
"webLineId": "1",
"quantity": 1
}
]
}
],
"orderTotal": {
"grandTotal": 609.9,
"grandTax": 39.9,
"grandCharges": 0,
"hdrTax": 0,
"hdrCharges": 0
}
}
}