Store Decline Notifications

Warning

This documentation is for translated notifications and intended only for some implementations who have upgraded from a previous version of Order Management. Verify whether your implementation uses translated APIs before continuing, as you will receive different data if your tenant is not configured to use these. If your implementation is not configured to do so, then refer to the standard Notifications documentation instead.

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.

FieldTypeParentDescription
eventTypeIDstring
Always show as StoreDeclineEvent.
orderIDinteger
The identifier of the order affected by the store decline.
externalLocationIDstring
The fulfiller’s identifier for the location.
locationNamestring
The name of the location.
eventTimestring
The time the store decline occurred.
reasonCodeinteger
The code explaining why the store declined (or canceled) the shipment. If a reason is not provided, then it will default to insufficient quantity.
reasonDescriptionstring
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.”
orderItemIDinteger
Null by default. This is only used for the cancel_item notification.
dataobject
Information on each line-item affected by this store decline.
itemIDintegerdataThe item’s identifier.
shipmentIDintegerdataThe identifier for the shipment this line item belongs to.
partNumberintegerdataThe part number of the line-item that has been declined.
upcstringdataThe upc code for the line-item that has been declined
quantityintegerdataThe quantity of the line-item that has been declined.
locationAvailabilityintegerdataThe location’s in-stock quantity of this line-item.
reasonCodeintegerdataThe code explaining why the store declined (or canceled) the line-item, if applicable.
reasonDescriptionstringdataThe 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"
    }
}