Hold Ticket Generate
URI Summary
POST /stores/{storeId}/nodes/{nodeId}/holdTicket/generate
Request Parameters
|
Parameter Type |
Name |
Description |
Required |
Definition |
Example |
|---|---|---|---|---|---|
|
Path |
storeId |
The store identifier |
yes |
String |
TMSUS |
|
Path |
nodeId |
The node identifier |
yes |
String |
TMS_NA-Store001 |
Request Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
StoreId |
yes |
The seller organization at which fulfillment order belongs. |
|
NodeId |
yes |
Fulfillment Order Ship Node |
|
pickTicketId |
yes |
The pick ticket id to be held |
|
fulfillmentOrderId |
yes |
The fulfillment order id to be held |
|
modifyAssociateId |
yes |
The associate making the request |
Request Payload Example
{
"storeId": "TMS_US",
"nodeId": "390-SFS-241",
"pickTicketId": "123",
"fulfillmentOrderId": "252552255810001",
"modifyAssociateId": "associate_id"
}
Responses
|
Http Status Code |
Description Responses |
|---|---|
|
201 |
Generated Hold Ticket Generate Response |
Response Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
holdTickets[{ |
yes |
|
|
holdTicketId |
yes |
The hold ticket identifier |
|
fulfillmentOrder{ |
yes |
|
|
fulfillmentOrderId |
yes |
Fulfillment Order Id |
|
storeId |
yes |
The seller organization to which this fulfillment order belongs. |
|
nodeId |
yes |
The node to which this order belongs |
|
webOrderId |
yes |
The web order ID associated with this fulfillment order |
|
omsOrderId |
yes |
The OMS order ID associated with this fulfillment order |
|
fulfillmentType |
yes |
Will always be same 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 |
|
fulfillmentOrderDate |
yes |
Release/Fulfillment Order create Date |
|
orderDate |
yes |
Fulfillment Order associated Sales Order creation date |
|
status |
yes |
Fulfillment Order Status Description |
|
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 |
PickTicket number the Fulfillment Order is associated with |
|
holdLocation |
no |
Hold Location information for Customer Pick Queue |
|
storeName |
yes |
Physical store this order is being processed in |
|
pinNumber |
no |
PIN number to be used on pickup if this feature is enabled |
|
fulfillmentOrderItems [{ |
yes |
|
|
id |
yes |
Sequential number for this item (1-n) |
|
itemId |
yes |
The identifier for the item, including catalog |
|
itemDesc |
yes |
The description of the item. |
|
orderedQuantity |
yes |
The quantity of the line item that was ordered |
|
status |
yes |
Fulfillment Order Status Description for the item |
|
proxyPickupAddress |
no |
If using a proxy, this is a reference to the proxy details |
|
quantity |
yes |
For ISPU this is the same as holdQuantity |
|
holdQuantity |
yes |
The quantity held |
|
canceledQuantity |
yes |
The quantity canceled during pick |
|
itemTotal { |
yes |
Prices associated with the item |
|
unitPrice |
yes |
|
|
extendedPrice |
yes |
|
|
charges |
yes |
|
|
tax |
yes |
|
|
proxyPickupDetails{ |
no |
|
|
id |
no |
proxyPickupAddress_1 |
|
personName{ |
no |
Proxy pickup Name |
|
firstName |
|
|
|
lastName |
|
|
|
|
no |
Proxy pickup Email |
|
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) |
|
relationship |
no |
e.g. “Friend” |
|
destinations[{ |
yes |
Not useful for ISPU unless billing address is checked |
|
destinationId |
yes |
Cross referenced above |
|
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 |
|
|
billToAddress{ |
yes |
Cross reference to the destinationId above for the customer’s information and billing address |
|
destinationId |
yes |
|
|
shippingAddress{ |
yes |
Cross reference to the shipping address above. Not useful for ISPU |
|
destinationId |
yes |
|
|
orderTotal{ |
yes |
Prices associated with the whole order |
|
grandTotal |
yes |
|
|
grandTax |
yes |
|
|
grandCharges |
no |
|
Response Payload Example
{
"holdTickets": [{
"holdTicketId": "123223",
"fulfillmentOrder": {
"fulfillmentOrderId": "100002343232001",
"storeId": "TMS_US",
"nodeId": "TMS_NA-DC001",
"webOrderId": "25255225581",
"omsOrderId": "100051718744",
"fulfillmentType": "STORE_PICK_UP",
"currency": "USD",
"carrier": "USPS",
"service": "2DAY",
"fulfillmentOrderDate": "2014-11-04T15:00:00+00:00",
"orderDate": "2014-11-04T15:00:00+00:00",
"status": "Shipment Created",
"totalVolume": {
"UOM": "CIN",
"value": 0.061
},
"totalWeight": {
"UOM": "LBS",
"value": 2.061
},
"pickTicketId": "12321312",
"holdLocation": "Loc-001",
"storeName": "Store A Seller XYZ",
"pinNumber" : 7298,
"fulfillmentOrderItems": [{
"id": "REF_1_Generated",
"itemId": "21-885641458409",
"itemDesc": "10360 6 PREM RUST NBK-WP",
"orderedQuantity": 1,
"status": "Shipment Created",
"proxyPickupAddress": "proxyPickupAddress_1",
"quantity": 2,
"holdQuantity": 1,
"canceledQuantity": 1,
"itemTotal": {
"unitPrice": 10.00,
"tax": 1.01,
"extendedPrice": 60.00,
"charges": 10.01
},
"customAttributes": [
{
"key": "PIN_NUMBER",
"value": "7298"
}
]
},
{
"id": "REF_2_Generated",
"itemId": "21-885641458410",
"itemDesc": "10360 6 PREM RUST NBK-WP",
"orderedQuantity": 1,
"status": "Ready for backroom pick",
"proxyPickupAddress": "proxyPickupAddress_1",
"quantity": 2,
"holdQuantity": 1,
"canceledQuantity": 1,
"itemTotal": {
"unitPrice": 10.00,
"tax": 1.01,
"extendedPrice": 60.00,
"charges": 10.01
},
"customAttributes": [
{
"key": "PIN_NUMBER",
"value": "M1EA0"
}
]
}
],
"proxyPickupDetails": {
"id": "proxyPickupAddress_1",
"address": {
"line1": "60 GREEN MOUNTAIN",
"city": "HAZLETON",
"mainDivisionCode": "PA",
"countryCode": "US",
"postalCode": "18202"
},
"personName": {
"lastName": "Minimum1",
"firstName": "Joe1"
},
"phone": "6100001000",
"email": "someone@someone@com",
"relationship": "Brother"
},
"destinations": [{
"destinationId": "billing_1",
"destinationType": "MAILING_ADDRESS",
"personName": {
"lastName": "Minimum1",
"firstName": "Joe1"
},
"phone": "2155551212",
"address": {
"line1": "104 Kingston Way",
"line2": "",
"line3": "",
"line4": "",
"city": "North Wales",
"mainDivisionCode": "PA",
"countryCode": "US",
"postalCode": "19454"
},
"emailId": "someone@someone@com"
},
{
"destinationId": "shipping_1",
"destinationType": "MAILING_ADDRESS",
"personName": {
"lastName": "Receiver",
"firstName": "Mary"
},
"phone": "2155551212",
"address": {
"line1": "104 Kingston Way",
"line2": "",
"line3": "",
"line4": "",
"city": "North Wales",
"mainDivisionCode": "PA",
"countryCode": "US",
"postalCode": "19454"
},
"emailId": "someoneelse@someone@com"
},
}]
}],
"billToAddress": {
"destinationId": "billing_1"
},
"shippingAddress": {
"destinationId": "shipping_1"
},
"orderTotal": {
"grandTotal": 100.12,
"grandTax": 1.01,
"grandCharges": 12.02,
}
}
}]
}