Pack Slip Generate
URI Summary
POST /stores/{storeId}/fulfillmentOrders/{fulfillmentOrderId}/packslip/generate
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 |
The node identifier |
|
modifyAssociateId |
yes |
The associate making the request |
|
fulfillmentOrderId |
yes |
The fulfillment order id needing a pack slip |
Request Payload Example
{
"storeId": "TMS_US",
"nodeId": "TMS_NA-DC001",
"modifyAssociateId": "associate_id",
"fulfillmentOrderId": "252552255810001"
}
Responses
|
Http Status Code |
Description |
|---|---|
|
200 |
PackSlipGenerateResponse |
|
400 |
Bad request |
|
500 |
Internal server error |
Response Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
packSlipDetails[{ |
yes |
|
|
packSlipId |
yes |
Internal identifier for this packslip. Can be ignored. |
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
nodeId |
yes |
The node identifier |
|
orderSource |
yes |
Same as storeId |
|
orderSourceType |
yes |
Same as nodeId |
|
hfrEligible |
yes |
true or false if this packslip should include a Hassle Free Returns label |
|
carrierException |
yes |
|
|
fulfillmentOrder{ |
yes |
Information required on the packslip will vary across clients. |
|
fulfillmentOrderId |
yes |
The identifier for this fulfillment order. |
|
omsOrderId |
yes |
The OMS order ID associated with this alert |
|
webOrderId |
no |
The original order id from the webstore |
|
externalOrderNumber |
no |
Contents (if any) will depend on what was agreed to at launch |
|
externalOrderNumber2 |
no |
Contents (if any) will depend on what was agreed to at launch |
|
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 |
|
packages[{ |
yes |
For mapping items into packages if you are going to generate a separate packslip for each package. |
|
packageId |
yes |
An internally generated identifier for this package |
|
packageItems[{ |
yes |
The items in the package |
|
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 |
|
orderedQuantity |
yes |
Quantity of this item on the order |
|
itemTotal{ |
yes |
|
|
unitPrice |
yes |
|
|
extendedPrice |
yes |
|
|
charges |
yes |
|
|
tax |
yes |
|
|
Instructions[{ |
no |
Will vary by client and may not be present. Contains instructions that store associates have been trained to perform. |
|
type |
yes |
|
|
text |
yes |
|
|
destinations[{ |
yes |
|
|
destinationId |
yes |
An identifier for cross-referencing under billToAddress and shippingAddress. |
|
destinationType |
yes |
MAILING_ADDRESS or SHIPPING_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 |
|
orderTotal{ |
yes |
|
|
grandTotal |
yes |
|
|
cashOnDelivery |
no |
|
|
grandTax |
yes |
|
|
grandCharges |
yes |
|
|
hdrTax |
yes |
|
|
hdrCharges |
yes |
|
Response Payload Example
{
"packSlipDetails": [{
"packSlipId": "100010989",
"storeId": "TMSUS",
"nodeId": "TMS_NA-Store1",
"orderSource": "TMSUS",
"orderSourceType": "TMS_NA-Store1",
"hfrEligible" : true,
"carrierException" : true,
"fulfillmentOrder": {
"fulfillmentOrderId": "100052251144001",
"omsOrderId": "100052251144",
"webOrderId" : "00272965655517DC",
"externalOrderNumber" : "00272965655517DC",
"externalOrderNumber2" : "409421675916",
"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",
"packages": [{
"packageId": "100131671",
"packageItems": [{
"webLineId": "1",
"quantity": 1
}]
}],
"fulfillmentOrderItems": [{
"id": "1",
"webLineId": "1",
"itemDetails": {
"itemId": "21-ISPUProd01"
},
"orderedQuantity": 1,
"itemTotal": {
"unitPrice": 114,
"extendedPrice": 114,
"charges": 0,
"tax": 6.84
},
"instructions": [{
"type": "GIFT",
"text": "Happy BirthDay"
}, {
"type": "DST_PACK",
"text": "Hopefully, this will come before you leave!"
}]
}],
"destinations": [{
"destinationId": "billing_1",
"destinationType": "MAILING_ADDRESS",
"personName": {
"firstName": "Herb",
"lastName": "Brooks"
},
"phone": "1111111111",
"address": {
"line1": "801 Hat Trick Avenue",
"city": "Eveleth",
"mainDivisionCode": "MN",
"postalCode": "",
"countryCode": "US"
},
"email": "RIT_E2E_240_LogPro@dashboard.gsi"
},
{
"destinationId": "shipping_1",
"destinationType": "SHIPPING_ADDRESS",
"personName": {
"firstName": "Herb",
"lastName": "Brooks"
},
"phone": "2155555555",
"address": {
"line1": "SOUTHSIDE SHOPPING CTR",
"city": "PITTSBURGH",
"mainDivisionCode": "PA",
"postalCode": "15203",
"countryCode": "US"
},
"email": "4373wm1@rsonline.gsicommerce.com"
}
],
"billToAddress": {
"destinationId": "billing_1"
},
"shippingAddress": {
"destinationId": "shipping_1"
},
"orderTotal": {
"grandTotal": 120.84,
“cashOnDelivery”:120.84,
"grandTax": 6.84,
"grandCharges": 0,
"hdrTax": 0,
"hdrCharges": 0
}
}
}]
}