Fulfillment Alert Summary
URI Summary
POST /stores/{storeId}/alert/fulfillment/search
Request Parameters
|
Parameter Type |
Name |
Description |
Required |
Definition |
Example |
|---|---|---|---|---|---|
|
Path |
storeId |
The store identifier |
yes |
String |
TMSUS |
Request Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
nodeId |
yes |
The node identifier |
|
webOrderId |
no |
Limit response to alerts for the specified webOrderId |
|
omsOrderId |
no |
Limit response to alerts for the specified omsOrderId |
|
alertType |
no |
Limit response to alerts of the specified type as configured in the ROM UI under SLA Definitions and Notifications |
|
description |
no |
Limit response to alerts with the specified description |
|
queueName |
no |
Limit response to alerts for the specified queue |
|
pickTicketId |
no |
Limit response to alerts for the specified pickTicketId |
|
fulfillmentTypes[ |
no |
Limit response to alerts for the specified fulfillment types in the list “STORE_PICK_UP", "SHIP_TO_HOME" “SHIP_TO_STORE”, "ASSOCIATE_DELIVERY" |
|
statuses |
no |
Limit response to alerts with the specified statuses in the list “OPEN”, “CLOSED” |
|
generatedOnDateRange{ |
no |
Limit response to alerts generated within the specified range |
|
from |
no |
Start of date range |
|
to |
no |
End of date range |
|
closedDate |
no |
Limit response to alerts closed on the specified date |
|
maxRecordsCount |
no |
Maximum number of records to return |
|
pageId |
no |
Return one particular page of output |
|
pageSize |
no |
Page size if asking for output by page number |
|
lastPageId |
no |
Last page number in case list is shown in pages |
|
lastRecordId |
no |
Fulfillment Order unique Key for pagination support
|
Request Payload Example
{
"storeId": "TMS_US",
"nodeId": "TMS_NA-DC001",
"webOrderId": "25255225581",
"omsOrderId": "10001233001",
"alertType": "PICK_SLA_DELAY",
"description": "Pickup SLA Delay Alert",
"queueName": "ISPU_PICK",
"pickTicketId": "11211212",
"fulfillmentTypes": [
"STORE_PICK_UP",
"SHIP_TO_HOME"
"ASSOCIATE_DELIVERY"
],
"statuses": [
"OPEN",
"CLOSED"
],
"generatedOnDateRange": {
"from": "2014-11-04T15:00:00+00:00",
"to": "2014-11-04T15:00:00+00:00"
},
"closedDate": "2016-01-19T19:22:38+00:00",
"maxRecordsCount": 100,
"pageId":3,
"pageSize":50,
"lastPageId":2,
"lastRecordId": 200
}
Responses
|
Http Status Code |
Description |
|---|---|
|
200 |
FulfillmentAlertSummaryResponse |
Response Payload Definition
|
Element |
Required |
Description |
|---|---|---|
|
Alerts[{ |
yes |
|
|
alertId |
yes |
Internal identifier for this alert. Can be ignored. |
|
storeId |
yes |
The seller organization at which fulfillment order belongs. |
|
nodeId |
yes |
The node identifier |
|
webOrderId |
yes |
The original order id from the webstore |
|
omsOrderId |
yes |
The OMS order ID associated with this alert |
|
alertType |
yes |
A value configured in the ROM UI under SLA Definitions and Notifications |
|
description |
yes |
Description of this alert |
|
queueName |
yes |
Name of the queue this alert is for |
|
pickTicketId |
no |
The pick ticket associated with this alert |
|
fulfillmentType |
yes |
“STORE_PICK_UP", "SHIP_TO_HOME" “SHIP_TO_STORE”, or "ASSOCIATE_DELIVERY"
|
|
status |
yes |
OPEN or CLOSED |
|
generatedOnDate |
yes |
When the order was generated |
|
closedDate |
no |
When the alert was closed, if it is closed |
|
consolidationCount |
yes |
Number of fulfillment orders this alert is representing |
|
pageId |
no |
If paging was requested |
|
pageSize |
no |
If paging was requested |
Response Payload Example
{
"alerts": [
{
"alertId": "20170610123133112311",
"storeId": "TMS_US",
"nodeId": "TMS_NA-DC001",
"webOrderId": "25255225581",
"omsOrderId": "10001233001",
"alertType": "PICK_SLA_DELAY",
"description": "Pickup SLA Delay Alert 1",
"queueName": "ISPU Pick UP Queue 1",
"pickTicketId": "11211212",
"fulfillmentType": "STORE_PICK_UP",
"status": "CLOSED",
"generatedOnDate": "2014-11-04T15:00:00+00:00",
"closedDate": "2015-11-04T15:00:00+00:00",
"consolidationCount": 1
},
{
"alertId": "20170610123133112312",
"storeId": "TMS_US",
"nodeId": "TMS_NA-DC001",
"webOrderId": "25255225582",
"omsOrderId": "10001233002",
"alertType": "PICK_SLA_DELAY",
"description": "Pickup SLA Delay Alert 2",
"queueName": "ISPU Pick UP Queue 2",
"pickTicketId": "11211212",
"fulfillmentType": "STORE_PICK_UP",
"status": "CLOSED",
"generatedOnDate": "2016-11-04T15:00:00+00:00",
"closedDate": "2021-11-04T15:00:00+00:00",
"consolidationCount": 2
}
]
"pageId":3,
"pageSize":50
}