Pack Details
This endpoint only supports the Ship-from Store fulfillment type.
URI Summary
POST /stores/{storeId}/fulfillmentOrders/{fulfillmentOrderId}/packages?nodeId={nodeId}
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 |
|
Query |
nodeId |
The node identifier |
yes |
Sring |
Store001 |
Request Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
nodeId |
yes |
The node identifier |
|
fulfillmentOrderId |
yes |
The fulfillment order id needing a pack slip |
Request Payload Example
Responses
|
Http Status Code |
Description |
|---|---|
|
200 |
PackDetailsResponse |
|
400 |
Bad request |
|
500 |
Internal server error |
Response Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
packDetail[{ |
yes |
|
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
nodeId |
yes |
The node identifier |
|
omsOrderId |
yes |
The OMS order ID associated with this alert |
|
fulfillmentOrderId |
yes |
The identifier for this fulfillment order. |
|
fulfillmentType |
yes |
SHIP_TO_HOME |
|
currency |
yes |
The currency the order was placed in. e.g. 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 |
Date parent order was generated. Will be the same or earlier than the fulfillmentOrderDate. |
|
status |
yes |
OMS internal status. Should probably be ignored |
|
totalVolume{ |
yes |
|
|
unit |
yes |
|
|
value |
yes |
|
|
totalWeight{ |
yes |
|
|
unit |
yes |
|
|
value |
yes |
|
|
pickTicketId |
|
|
|
packages[{ |
yes |
|
|
packageId |
yes |
An internally generated identifier for this package |
|
trackingNumber |
yes |
Returned from shipper |
|
boxId |
yes |
Identifier for this box. Typically a sequence number starting with 1 |
|
boxWeight |
yes |
Weight of the box (total) |
|
unit |
yes |
|
|
value |
yes |
|
|
packingMaterialWeight{ |
yes |
Weight of the packing materials |
|
unit |
yes |
|
|
value |
yes |
|
|
weight{ |
yes |
weight of the item |
|
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 |
The items in the package |
|
itemId |
yes |
Item identifier including catalog number |
|
webLineId |
yes |
Cross references the webLineId in fulfillmentOrderItems |
|
quantity |
yes |
The quantity of the item in this package |
|
fulfillmentOrderItems[{ |
yes |
|
|
id |
yes |
A sequentially assigned identifier for this item |
|
webLineId |
yes |
The line id from the original order |
|
itemDetails{ |
yes |
|
|
itemId |
yes |
Item identifier including catalog number |
|
itemDesc |
yes |
Description of item |
|
hazmatIndicator |
no |
Does this require HazMat labeling? |
|
upcs[{ |
yes |
UPCs on this item |
|
type |
yes |
This field can be ignored |
|
value |
yes |
UPC code itself |
|
quantity |
yes |
Quantity of this item |
|
destinations[{ |
yes |
|
|
destinationId |
yes |
An identifier for cross-referencing under billToAddress and shippingAddress. |
|
destinationType |
yes |
MAILING_ADDRESS, SHIPPING_ADDRESS or NODE_ADDRESS |
|
personName{ |
yes |
|
|
firstName |
yes |
|
|
lastName |
yes |
|
|
phone |
yes |
|
|
address{ |
yes |
|
|
line1 |
yes |
|
|
line2 |
no |
|
|
city |
yes |
|
|
mainDivisionCode |
yes |
|
|
postalCode |
yes |
|
|
countryCode |
yes |
|
|
|
yes |
|
|
billToAddress{ |
yes |
|
|
destinationId |
yes |
Cross reference of one of the destinations above |
|
shippingAddress{ |
yes |
|
|
destinationId |
yes |
Cross reference of one of the destinations above |
|
shipFromAddress{ |
yes |
|
|
destinationId |
yes |
Cross reference of one of the destinations above |
Response Payload Example
{
"packDetail": {
"storeId": "TMSUS",
"nodeId": "TMS_NA-Store1",
"omsOrderId": "100052251144",
"fulfillmentOrderId": "100052251144001",
"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",
"status": "1600.002",
"totalVolume": {
"unit": "CIN",
"value": 0.061
},
"totalWeight": {
"unit": "LBS",
"value": 2.2046
},
"pickTicketId": "100010988",
"packages": [
{
"packageId": "100131671",
"trackingNumber": "1Z11111991100",
"boxId":"4X4X4",
"boxWeight": {
"unit": "LBS",
"value": 1
},
"packingMaterialWeight": {
"unit": "LBS",
"value": 1
},
"weight": {
"unit": "LBS",
"value": 2.2046
},
"length": {
"unit": "IN",
"value": 1.0
},
"height": {
"unit": "IN",
"value": 3.1
},
"width": {
"unit": "IN",
"value": 3.9
},
"packageItems": [
{
"itemId": "21-ISPUProd01",
"webLineId": "1",
"quantity": 1
}
]
}
],
"fulfillmentOrderItems": [
{
"id": "1",
"webLineId": "1",
"itemDetails": {
"itemId": "21-ISPUProd01",
"itemDesc": "Black Tennis Shoes",
"hazmatIndicator": true,
"upcs": [
{
"type": "P",
"value": "355470307"
}
]
},
"quantity": 1
}
],
"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"
},
{
"destinationId": "shipping_1",
"destinationType": "SHIPPING_ADDRESS",
"personName": {
"firstName": "Herb",
"lastName": "Brooks"
},
"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": {
"firstName": "Model",
"lastName": "Store1"
},
"phone": "4841111111",
"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"
}
}
}