Queue Assignment Summary
URI Summary
POST /stores/{storeId}/nodes/{nodeId}/fulfillmentOrders?queueId={queueId}
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 |
|
Query |
queueId |
The queueId for which to retrieve assignment information |
yes |
String |
100234001001 |
Request Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
storeId |
yes |
Retrieve orders belonging to Seller |
|
modeId |
yes |
Retrieve orders belonging to Ship Node |
|
queueId |
yes |
Retrieve orders in Fulfillment Queue Id |
|
fulfillmentType |
no |
Fulfillment Type |
|
carrier |
no |
Fulfillment Order Shipping SCAC |
|
service |
no |
Fulfillment Order Shipping Carrier |
|
shipMethod |
no |
Fulfillment Order Shipping SCAC and Service |
|
pickTicketId |
no |
PickTicket no the Fulfillment Order associated with |
|
fulfillmentOrderId |
no |
Fulfillment Order Id to retrive |
|
webOrderId |
no |
Web Order Id to retrieve |
|
zipCodeRange{ |
no |
Retrieve fulfillment orders in a specific zip code range |
|
from |
yes |
|
|
to |
yes |
|
|
orderDateRange |
|
Retrieve fulfillment orders in a specific order date range |
|
from |
yes |
|
|
to |
yes |
|
|
fulfillmentOrderDateRange |
|
Retrieve fulfillment orders in a specific fulfillment date range |
|
from |
yes |
|
|
to |
yes |
|
|
expectedDeliveryDateRange |
|
Retrieve fulfillment orders in a specific delivery date range |
|
from |
yes |
|
|
to |
yes |
|
|
customer{ |
no |
Retrieve fulfillment orders for a specific customer |
|
name |
yes |
|
|
|
yes |
|
|
phone |
yes |
|
|
trackingNumber |
no |
Retrieve fulfillment order for a specific tracking number |
|
pinNumber |
no |
Retrieve fulfillment orders by pin number |
|
proxyDetails{ |
no |
Retrieve fulfillment orders by proxy |
|
name |
yes |
|
|
|
yes |
|
|
phone |
yes |
|
|
pageId |
no |
Page number in case result list is shown in pages |
|
pageSize |
no |
Page Size in case result list is shown in pages |
|
lastPageId |
no |
Last page number in case list is shown in pages |
|
maxRecordsCount |
no |
Maximum number of Fulfillment records to be retrieved. |
|
lastRecordId |
no |
Fulfillment Order unique Key for pagination support
|
Request Payload Example
{
"storeId": "TMS_US",
"nodeId": "TMS_NA-DC001",
"queueId": "QUE-123",
"fulfillmentType": "STORE_PICK_UP",
"carrier": "USPS",
"service": "2DAY",
"shipMethod": "USPS_2DAY",
"pickTicketId": "12345",
"fulfillmentOrderId": "100234001001",
"webOrderId": "100042583",
"zipCodeRange": {
"from": "19406",
"to": "19406"
},
"orderDateRange": {
"from": "2014-10-04T15:00:00+00:00",
"to": "2014-11-04T15:00:00+00:00"
},
"fulfillmentOrderDateRange": {
"from": "2014-10-04T15:00:00+00:00",
"to": "2014-11-04T15:00:00+00:00"
},
"expectedDeliveryDateRange": {
"from": "2014-10-04T15:00:00+00:00",
"to": "2014-11-04T15:00:00+00:00"
},
"customer": {
"name": "NameCust1",
"email": "cust1@email.com",
"phone": "4201234321"
},
"trackingNumber":"1QW234456E234234",
"pinNumber" : "7298",
"proxyDetails": {
"name": "NameProxy1",
"email": "proxy1@email.com",
"phone": "4201234322"
},
"pageId":3,
"pageSize":50,
"lastPageId":2,
"maxRecordsCount": 100,
"lastRecordId": 100
}
Responses
|
Http Status Code |
Description |
|---|---|
|
200 |
The QueueAssignmentResponse |
Response Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
fulfillmentOrders[{ |
yes |
|
|
fulfillmentOrderId |
yes |
|
|
storeId |
yes |
The seller organization to which this fulfillment order belongs. |
|
nodeId |
yes |
The node to which this order belongs |
|
omsOrderId |
yes |
The OMS order ID associated with this fulfillment order |
|
fulfillmentOrderDate |
yes |
Release/Fulfillment Order create Date |
|
holdLocation |
no |
Hold Location information for Customer Pick Queue |
|
expectedDeliveryDate |
no |
Expected Delivery Date of the fulfillment order |
|
orderDate |
yes |
Fulfillment Order associated Sales Order creation date |
|
fulfillmentType |
yes |
Will always be the same for ISPU |
|
carrier |
yes |
Fulfillment Order Shipping Carrier. Not useful for ISPU |
|
service |
yes |
Fulfillment Order Shipping SCAC. Not useful for ISPU. |
|
shipMethod |
yes |
Fulfillment Order Shipping SCAC and Service. Not useful for ISPU. |
|
pickTicketId |
no |
PickTicket number the Fulfillment Order is associated with |
|
status |
yes |
Fulfillment Order Status Description |
|
totalNoOfItems |
yes |
Total number of items on a fulfillment order |
|
totalQuantity |
yes |
Total quantity of all items available on a fulfillment order |
|
totalNoOfPackages |
yes |
Total number of packages on a fulfillment order |
|
pinNumber |
no |
PIN number to be used on pickup if this feature is enabled |
|
trackingNumbers[ |
no |
List of tracking numbers (does not apply for ISPU) |
|
customer{ |
no |
Customer for this fulfillment order |
|
name |
yes |
|
|
|
yes |
|
|
phone |
yes |
|
|
proxyDetails{ |
no |
Proxy for this fulfillment order |
|
name |
yes |
|
|
|
yes |
|
|
phone |
yes |
|
|
slaDate{ |
yes |
Next SLA |
|
slaTypeId |
yes |
|
|
value |
yes |
|
|
shippingAddress{ |
yes |
Cross reference with destination below. Not useful for ISPU |
|
destinationId |
yes |
|
|
destinations[{ |
yes |
Not useful for ISPU. |
|
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 |
|
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) |
|
phone |
no |
Customer phone number |
|
pageId |
yes |
Page number in case result list is shown in pages |
|
PageSize |
yes |
Page Size in case result list is shown in pages |
Response Payload Example
{
"fulfillmentOrders": [
{
"fulfillmentOrderId": "100234001001",
"storeId": "TMS_US",
"nodeId": "391-TMS_US-001",
"omsOrderId": "100234001",
"fulfillmentOrderDate": "2021-01-03T07:14:10+00:00",
"holdLocation": "Loc1-123",
"expectedDeliveryDate": "2021-01-03T07:14:10+00:00",
"orderDate": "2021-01-03T07:14:10+00:00",
"fulfillmentType": "STORE_PICK_UP",
"carrier": "USPS",
"service": "2DAY",
"shipMethod": "FEDEX_1DAY",
"pickTicketId": "12345",
"status": "Shipment Created",
"totalNoOfItems": "2",
"totalQuantity": "1",
"totalNoOfPackages": "1",
"pinNumber" : "7298",
"trackingNumbers": [
"1QW234456E234234"
],
"customer": {
"name": "NameCust1",
"email": "cust1@email.com",
"phone": "4201234321"
},
"proxyDetails": {
"name": "NameProxy1",
"email": "proxy1@email.com",
"phone": "4201234322"
},
"slaDate": {
"slaTypeId": "WAITING_FOR_PICK",
"value": "2021-05-09T19:16:59+00:00"
},
"shippingAddress": {
"destinationId": "shipping_1"
},
"destinations": [
{
"destinationId": "shipping_1",
"destinationType": "SHIPPING_ADDRESS",
"personName": {
"lastName": "Minimum1",
"firstName": "Joe1"
},
"address": {
"line1": "104 Kingston Way",
"line2": "",
"line3": "",
"line4": "",
"city": "North Wales",
"mainDivisionCode": "PA",
"countryCode": "US",
"postalCode": "19454"
},
"phone": "2155551212"
}
]
},
{
"fulfillmentOrderId": "100234002001",
"storeId": "TMS_EU",
"nodeId": "391-TMS_US-001",
"omsOrderId": "100234002",
"fulfillmentOrderDate": "2021-01-03T07:14:10+00:00",
"holdLocation": "Loc1-123",
"expectedDeliveryDate": "2021-01-03T07:14:10+00:00",
"orderDate": "2021-01-03T07:14:10+00:00",
"fulfillmentType": "STORE_PICK_UP",
"carrier": "FEDEX",
"service": "1DAY",
"shipMethod": "FEDEX_1DAY",
"pickTicketId": "12345",
"status": "Shipment Created",
"totalNoOfItems": "2",
"totalQuantity": "1",
"totalNoOfPackages": "0",
"customer": {
"name": "NameCust2",
"email": "cust1@email.com",
"phone": "4201234321"
},
"proxyDetails": {
"name": "NameProxy2",
"email": "proxy1@email.com",
"phone": "4201234322"
},
"slaDate": {
"slaTypeId": "WAITING_FOR_PICK",
"value": "2021-05-09T19:16:59+00:00"
},
"shippingAddress": {
"destinationId": "shipping_1"
},
"destinations": [
{
"destinationId": "shipping_1",
"destinationType": "SHIPPING_ADDRESS",
"personName": {
"lastName": "Minimum1",
"firstName": "Joe1"
},
"address": {
"line1": "104 Kingston Way",
"line2": "",
"line3": "",
"line4": "",
"city": "North Wales",
"mainDivisionCode": "PA",
"countryCode": "US",
"postalCode": "19454"
},
"phone": "2155551212",
"email": "4373wm1@rsonline.gsicommerce.com"
}
]
},
{
"fulfillmentOrderId": "100234003001",
"storeId": "TMS_EU",
"nodeId": "391-TMS_US-001",
"omsOrderId": "100234003",
"fulfillmentOrderDate": "2021-01-03T07:14:10+00:00",
"holdLocation": "Loc1-123",
"expectedDeliveryDate": "2021-01-03T07:14:10+00:00",
"orderDate": "2021-01-03T07:14:10+00:00",
"fulfillmentType": "STORE_PICK_UP",
"carrier": "FEDEX",
"service": "1DAY",
"shipMethod": "FEDEX_1DAY",
"pickTicketId": "12345",
"status": "Shipment Created",
"totalNoOfItems": "2",
"totalQuantity": "1",
"totalNoOfPackages": "1",
"customer": {
"name": "NameCust3",
"email": "cust1@email.com",
"phone": "4201234321"
},
"proxyDetails": {
"name": "NameProxy3",
"email": "proxy1@email.com",
"phone": "4201234322"
},
"slaDate": {
"slaTypeId": "WAITING_FOR_PICK",
"value": "2021-05-09T19:16:59+00:00"
},
"shippingAddress": {
"destinationId": "shipping_1"
},
"destinations": [
{
"destinationId": "shipping_1",
"destinationType": "SHIPPING_ADDRESS",
"personName": {
"lastName": "Minimum1",
"firstName": "Joe1"
},
"address": {
"line1": "104 Kingston Way",
"line2": "",
"line3": "",
"line4": "",
"city": "North Wales",
"mainDivisionCode": "PA",
"countryCode": "US",
"postalCode": "19454"
},
"phone": "2155551212",
"email": "4373wm1@rsonline.gsicommerce.com"
}
]
}
],
"pageId": 3,
"pageSize": 50
}