Pack Update
This endpoint only supports the Ship-from Store fulfillment type.
URI Summary
PUT /stores/{storeId}/fulfillmentOrders/{fulfillmentOrderId}/package/update
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 |
|---|---|---|
|
modifyAssociateId |
yes |
The ID of the associate confirming the package |
|
packDetails{ |
yes |
|
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
nodeId |
yes |
The node identifier |
|
fulfillmentOrderId |
yes |
The fulfillment order identifier |
|
packages{ |
yes |
|
|
action |
yes |
CREATE or MODIFY |
|
trackingNumber |
yes |
Returned from shipper |
|
boxId |
yes |
Identifier for this box. Typically a sequence number starting with 1 |
|
boxWeight |
yes |
Weight of the box |
|
unit |
yes |
|
|
value |
yes |
|
|
packingMaterialWeight{ |
yes |
Weight of the packing materials |
|
unit |
yes |
|
|
value |
yes |
|
|
length{ |
yes |
Length of the box |
|
unit |
yes |
|
|
value |
yes |
|
|
height{ |
yes |
Height of the box |
|
unit |
yes |
|
|
value |
yes |
|
|
width{ |
yes |
Width of the box |
|
unit |
yes |
|
|
value |
yes |
|
|
packageItems[{ |
yes |
Items in the box |
|
itemId |
yes |
Actual item id with catalog number |
|
webLineId |
yes |
Line in the original web order |
|
quantity |
yes |
Quantity in the box |
|
instructions[{ |
no |
Optional instructions |
|
type |
yes |
Client-specific |
|
text |
yes |
|
|
customAttributes[{ |
no |
Client-specific |
|
key |
yes |
|
|
value |
yes |
|
Request Payload Example
{
"modifyAssociateId": "associate_id",
"packDetails": {
"storeId": "TMSUS",
"nodeId": "TMS_NA-Store1",
"fulfillmentOrderId": "100052259714001",
"packages": [
{
"action": "CREATE",
"trackingNumber":"100047839154001998",
"boxId": "323",
"boxWeight": {
"unit": "LBS",
"value": 1
},
"packingMaterialWeight":
{
"unit": "LBS",
"value": 1
},
"length": {
"unit": "IN",
"value": 0
},
"height": {
"unit": "IN",
"value": 0
},
"width": {
"unit": "IN",
"value": 0
},
"packageItems": [
{
"itemId": "21-ISPUProd01",
"webLineId": "1",
"quantity": "1"
}
],
"instructions": [
{
"type": "Type",
"text": "Type"
}
],
"customAttributes": [
{
"key": "Key",
"value": "20170816"
}
]
}
]
}
}
Responses
|
Http Status Code |
Description |
|---|---|
|
204 |
Success, no response |
|
400 |
Bad request |
|
500 |
Internal server error |