Settings | Event Subscriptions

Returns the filter values this tenant accepts — object types, statuses, markets, stores, warehouses and users.

Call this first when building a subscription's filters: the values are tenant-specific, so an order status or market id that exists on one tenant may not exist on another. Send the value of an option in the matching filters list; displayName is for showing a human.

classes is nested because some filters only apply to certain object types. Each entry carries the statuses, sub types, workflow steps and tags valid for that type, plus supports* flags saying whether market, store, store-group, warehouse and property filtering apply to it at all.

{
  "classes": [
    {
      "className": { "value": "Order", "displayName": "Order" },
      "statuses": [{ "value": "Created", "displayName": "Created", "translationKey": "OrderCreated" }],
      "supportsMarketFilter": true,
      "supportsWarehouseFilter": false
    }
  ],
  "markets": [{ "value": "NOR", "displayName": "Norway" }]
}
get/api/EventSubscriptions/Filters

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/EventSubscriptions/Filters
  • Auth: API key in header Authorization

Response

Filter options returned.

Changes

No recorded changes to this operation across all 1 revision of this API.