Skip to Content
DispatchersConditions

Conditions

Conditions are the building blocks of dispatcher rules. Each condition compares a field on the order to a value using an operator.

Condition Structure

{
  "field": "totalPrice",
  "operator": "gte",
  "value": 500
}

Available Fields

FieldTypeDescription
statusstringOrder status
financialStatusstringPayment status
totalPricenumberOrder total
subtotalPricenumberSubtotal
currencystringCurrency code
tagsstring[]Order tags
shippingAddress.statestringShipping state
shippingAddress.countrystringShipping country
shippingAddress.zipstringPostal code
customer.emailstringCustomer email
lineItems.lengthnumberNumber of line items
sourcestringSource platform
bridgeIdstringSource bridge ID
metadata.*anyCustom metadata fields

Operators

OperatorDescriptionExample
eqEqualsstatus eq "pending"
neqNot equalsstatus neq "cancelled"
gtGreater thantotalPrice gt 100
gteGreater than or equaltotalPrice gte 100
ltLess thantotalPrice lt 50
lteLess than or equaltotalPrice lte 50
containsString/array containstags contains "priority"
not_containsDoes not containtags not_contains "hold"
starts_withString starts withshippingAddress.zip starts_with "90"
ends_withString ends withcustomer.email ends_with "@company.com"
inValue in liststatus in ["pending", "processing"]
not_inValue not in liststatus not_in ["cancelled", "returned"]
existsField existsmetadata.priority exists
not_existsField doesn’t existmetadata.priority not_exists
DispatchersCondition Sets