CustomNotification Filters

The filter object is present to allow users to enter filter criteria for a notification. Object options can be seen below:

Parameter

Type

Description

propertyName

String

Name of the Filter as seen below.

propertyValue

String

Accepted values as seen: Notification Filter Accepted Values

Below are the filter options available to users when filtering on a Custom Notification:

Value

Filter Name

Description

Brands

Brand/Business Unit

Brand used on the shipment.

DestinationDisplay

Destination

Valid City/State for the destination of a shipment.

DestinationStateCode

To State

State code of a destination on a shipment.

EquipmentType

Equipment Type

Notification Filter Accepted Values

HotShipments

Hot Shipments

Notification Filter Accepted Values

ModeType

Mode Type

Notification Filter Accepted Values

OrderExceptions

Order Exceptions

Notification Filter Accepted Values

OriginDisplay

Origin

Valid City/State for the origin of a shipment.

OriginFixedLocation

Outbound Location

A fixed location when used as the origin on a shipment.

OriginStateCode

From State

The state code for a state used on the origin of a shipment.

PartnerName

Partner/Carrier

The carrier or shipping partner on a shipment. Partner is used for a carrier organization while carrier is used for shipper organization.

ProductCustomers

Customer

The customer on a shipment.

ProductLines

Products

The product on a shipment.

Skus

SKU/Commodity

The SKU/Commodity on a shipment.

Status

Shipment Status

Notification Filter Accepted Values