v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
RulesEngine

GetActionTypes

Use this call to retrieve a list of valid action types for rules engine <b>Permissions Required: </b> GlobalPermissions.OrderBook.RulesEngineNode <b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

get/api/RulesEngine/GetActionTypes

Query parameters

type'Test' | 'Orders'

The rule type. Optional, defaults to orders as this is the only supported type.

Response

OK

DisplayNamestring

The display name for the action

Value'Unknown' | 'AssignShippingService' | 'AssignToFolder' | 'AssignToLocation' | 'SplitOrderByWeight' | 'SplitOrderByValue' | 'SplitOrderSingle' | 'AssignOrderExtendedProperty' | 'ChangeOrderLockStatus' | 'ChangeOrderParkStatus' | 'AssignTagToOrder' | 'ExecuteMacro' | 'AssignIdentifierToOrder' | 'BlockOrderFromMerging' | 'SendToFulfillmentNetwork' | 'SetDispatchDate' | 'AddItemToOrder' | 'AddServiceToOrder' | 'AddNoteToOrder'

The action type