Fulfillment Order Modify
URI Summary
POST /stores/{storeId}/fulfillmentOrders/{fulfillmentOrderId}/Modify
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 |
|
modifyAssociateId |
no |
The associate making the request |
|
action |
yes |
CANCEL/MODIFY/AddToPackQueue/RemoveFromPackQueue. Order should be removed from pack queue before modification and returned to pack queue after. Only the shipping information can be modified. |
|
fulfillmentOrderItems[{ |
yes |
|
|
id |
yes |
A sequential ID for this order item |
|
webLineId |
yes |
Line number on the original web order |
|
itemId |
yes |
Full item ID with catalog number |
|
quantity |
yes |
Quantity returned in the fulfillmentOrders call. Do not modify. |
|
reasonCode |
yes |
Reason codes and descriptions are configured in the ROM UI |
|
reasonDescription |
yes |
Reason codes and descriptions are configured in the ROM UI |
|
destinations[{ |
no |
Not required for cancel. Shipping destination is required for MODIFY |
|
destinationId |
no |
Destination to be modified |
|
destinationType |
no |
MAILING_ADDRESS or SHIPPING_ADDRESS |
|
personName{ |
no |
|
|
firstName |
no |
|
|
lastName |
no |
|
|
phone |
no |
|
|
address{ |
no |
|
|
line1 |
no |
|
|
line2 |
no |
|
|
city |
no |
|
|
mainDivisionCode |
no |
|
|
countryCode |
no |
|
|
|
no |
|
|
shippingAddress{ |
no |
|
|
destinationId |
no |
ID to be to used for the shipping address. Could be the address modified or could be the ID of the bill address destination. |
Request Payload Example
{
"storeId": "TMS_US",
"nodeId": "TMS_NA-Store001",
"fulfillmentOrderId": "100051718744001",
"modifyAssociateId": "associate_id",
"action": "CANCEL/MODIFY/AddToPackQueue/RemoveFromPackQueue",
"fulfillmentOrderItems": [
{
"id": "id1",
"webLineId": "1",
"itemId": "21-885641458409",
"quantity": "1",
"reasonCode": "IPD",
"reasonDesription": "Customer Denied"
}
]
"destinations": [
{
"destinationId": "shipping_1",
"destinationType": "MAILING_ADDRESS",
"personName": {
"firstName": "Mary",
"lastName": "Receiver"
},
"phone": "7410852963",
"address": {
"line1": "630 allendale road",
"line2": "Radial",
"city": "King of Prussia",
"mainDivisionCode": "PA",
"countryCode": "US"
},
"email": "4373wm1@radial.com"
}
],
"shippingAddress": {
"destinationId": "shipping_1"
}
}
Responses
|
Http Status Code |
Description |
|---|---|
|
204 |
Success, no content |
|
400 |
Bad request |
|
500 |
Internal server error |