A Store Decline Notification is triggered when a shipment undergoes any of the following events:
- A shipment is placed back into WFMA status and reassigned through Order Routing
- A shipment is canceled (this transition will send both the Store Decline and Cancel Shipment/Item notification)
- A shipment is sent to the “Customer Care” state (code: 125)
Note that this notification is not sent for cancellations of an order that is currently in Backorder or WFMA status, as this is not considered a decline. Additionally, it can only be sent if the order is inventory-based.
Notification Parameters
The fields returned in the Store Decline Notification are described in the below table.
Field | Type | Parent | Description |
eventTypeID | string | Always show as StoreDeclineEvent. | |
orderID | integer | The identifier of the order affected by the store decline. | |
externalLocationID | string | The fulfiller’s identifier for the location. | |
locationName | string | The name of the location. | |
eventTime | string | The time the store decline occurred. | |
reasonCode | integer | The code explaining why the store declined (or canceled) the shipment. If a reason is not provided, then it will default to insufficient quantity. | |
reasonDescription | string | The human-readable explanation for why the store declined (or canceled) the shipment. If a reason is not provided, then it will default to “Don’t have enough quantity.” | |
orderItemID | integer | Null by default. This is only used for the cancel_item notification. | |
data | object | Information on each line-item affected by this store decline. | |
itemID | integer | data | The item’s identifier. |
shipmentID | integer | data | The identifier for the shipment this line item belongs to. |
partNumber | integer | data | The part number of the line-item that has been declined. |
upc | string | data | The upc code for the line-item that has been declined |
quantity | integer | data | The quantity of the line-item that has been declined. |
locationAvailability | integer | data | The location’s in-stock quantity of this line-item. |
reasonCode | integer | data | The code explaining why the store declined (or canceled) the line-item, if applicable. |
reasonDescription | string | data | The human-readable explanation for why the store declined (or canceled) the line-item, if applicable. |
The following example shows what a Store Decline Notification may look like.
{ "eventTypeID" : "StoreDeclineEvent", "orderID" : "808080", "externalLocationID" : "4400440", "locationName" : "Test Distribution", "eventTime" : "2015-01-10 01:01:00", "reasonCode" : null, "reasonDescription" : null, "data" : [ { "itemID" : "12121212", "shipmentID" : "919191", "partNumber" : "88887777", "upc" : "88887777", "quantity" : "1", "locationAvailability" : 3, "reasonCode" : "102", "reasonDescription" : "On a mannequin or display" } ], "scope": { "mfgID" : "11111", "catalogID" : "0", "fulfillerID" : "70125" } }