Fulfillment Order Summary
URI Summary
POST /stores/{storeId}/fulfillmentOrder/search
Request Parameters
None.
Request Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
nodeId |
yes |
Fulfillment Order Ship Node |
|
userId |
no |
Limit to a particular user |
|
webOrderId |
no |
Limit to a particular web order id |
|
omsOrderId |
|
Limit to a particular OMS order id |
|
orderDateRange{ |
no |
Limit to an order date range |
|
from |
yes |
e.g. 2014-11-04T15:00:00+00:00 |
|
to |
yes |
e.g. 2014-11-04T15:00:00+00:00 |
|
fulfillmentOrder{ |
no |
|
|
fulfillmentOrderId |
no |
Limit to a particular fulfillment order |
|
fulfillmentTypes[] |
no |
"STORE_PICK_UP" |
|
statuses{ |
no |
Search by numeric status range. Not recommended as these are subject to change |
|
from |
yes |
|
|
to |
yes |
|
|
customer{ |
no |
Search by customer |
|
name |
yes |
|
|
|
yes |
|
|
phone |
yes |
|
|
proxyDetails |
no |
Search by proxy |
|
name |
yes |
|
|
|
yes |
|
|
phone |
yes |
|
|
fulfillmentOrderDateRange{ |
no |
|
|
from |
yes |
e.g. 2014-11-04T15:00:00+00:00 |
|
to |
yes |
e.g. 2014-11-04T15:00:00+00:00 |
|
pageId |
no |
Page number to show |
|
pageSize |
no |
Number of records per page |
|
maxRecordsCount |
no |
Max records to return |
Request Payload Example
{
"storeId": "TMS_US",
"nodeId": "TMS_NA-DC001",
"userId": "UserId001",
"webOrderId": "25255225581",
"omsOrderId": "100002343232",
"orderDateRange": {
"from": "2014-11-04T15:00:00+00:00",
"to": "2014-11-04T15:00:00+00:00"
},
"fulfillmentOrder": {
"fulfillmentOrderId": "100002343232",
"fulfillmentTypes": [
"STORE_PICK_UP",
"SHIP_TO_HOME"
],
"statuses": {
"from": 1100,
"to": 1500
},
"customer": {
"name": "NameCust1",
"email": "cust1@email.com",
"phone": "4201234321"
},
"proxyDetails": {
"name": "NameCust1",
"email": "cust1@email.com",
"phone": "4201234321"
},
"fulfillmentOrderDateRange": {
"from": "2014-11-04T15:00:00+00:00",
"to": "2014-11-04T15:00:00+00:00"
}
},
"pageId":3,
"pageSize":50,
"maxRecordsCount": 100
}
Responses
|
Http Status Code |
Description |
|---|---|
|
200 |
FulfillmentOrderSummaryResponse |
Response Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
fulfillmentOrders[{ |
yes |
|
|
fulfillmentId |
yes |
Identifier assigned to this fulfillment |
|
fulfillmentOrderId |
yes |
Fulfillment Order ID |
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
nodeId |
yes |
Fulfillment Order Ship Node |
|
omsOrderId |
yes |
Order ID assigned by the OMS |
|
WebOrderId |
yes |
Sales Order web number |
|
FulfillmentType |
yes |
Fulfillment Type. Always STORE_PICK_UP for ISPU |
|
carrier |
yes |
Fulfillment Order carrierService |
|
service |
yes |
Fulfillment Order Shipping SCAC |
|
fulfillmentOrderDate |
yes |
Fulfillment Order create Date |
|
orderDate |
yes |
Sales Order Create Date |
|
status |
yes |
Fulfillment Order status. See introduction. Subject to change. |
|
customer{ |
yes |
Customer |
|
name |
|
|
|
|
|
|
|
phone |
|
|
|
proxyDetails{ |
no |
Proxy |
|
name |
yes |
|
|
|
yes |
|
|
phone |
yes |
|
|
pageId |
no |
Number of page returned |
|
pageSize |
no |
Size of each page |
|
totalRecords |
no |
Total record count in search result |
Response Payload Example
{
"fulfillmentOrders": [
{
"fulfillmentId": "20171124184753768670740",
"fulfillmentOrderId": "100052362714001",
"storeId": "TMSUS",
"nodeId": "TMS_NA-Store1",
"omsOrderId": "100052362714",
"webOrderId": "0002614565823753",
"fulfillmentType": "STORE_PICK_UP",
"carrier": "ISPU",
"service": "ISPU",
"fulfillmentOrderDate": "2021-11-24T18:47:53+00:00",
"orderDate": "2021-11-24T18:47:34+00:00",
"status": "1600.002",
"customer": {
"name": "NONAME",
"email": "nonamepickup@abc.com",
"phone": "7894561239"
}
"proxyDetails": {
"name": "NONAME",
"email": "nonamepickup@abc.com",
"phone": "7894561239"
}
},
{
"fulfillmentId": "20171124184753768670741",
"fulfillmentOrderId": "100052362714002",
"storeId": "TMSUS",
"nodeId": "TMS_NA-Store1",
"omsOrderId": "100052362714",
"webOrderId": "0002614565823753",
"fulfillmentType": "STORE_PICK_UP",
"carrier": "ISPU",
"service": "ISPU",
"fulfillmentOrderDate": "2021-11-24T18:47:53+00:00",
"orderDate": "2021-11-24T18:47:34+00:00",
"status": "1600.002",
"customer": {
"name": "NONAME",
"email": "nonamepickup@abc.com",
"phone": "7894561239"
}
"proxyDetails": {
"name": "NONAME",
"email": "nonamepickup@abc.com",
"phone": "7894561239"
}
}
],
"pageId": 1,
"pageSize": 50,
"totalRecords": 2
}