Sign in

v1

latestOpenAPI 3.1.02026-07-2296226496.3 KB
Dispatch Strategies

Get dispatch strategies

List all dispatch strategies (options groups) configured for the organization. Dispatch strategies define provider selection rules, fallback logic, and quoting behavior.

get/v1/options_group

Response

OK

idstring required

Dispatch Strategy ID

labelstring required

Dispatch Strategy Label

allowedProvidersstring[] nullable

Allowed providers

enableAutoDispatchboolean nullable

Enable auto dispatch

providerSelectionStrategystring nullable

Provider selection strategy

reassignOnFailureboolean nullable

Reassign on failure

enableMaxDeliveryFeeboolean nullable

Enable max delivery fee

maxDeliveryFeeCentsinteger nullable

Max delivery fee in cents

costSplitMaxFixedPriceCentsinteger nullable

Cost split max fixed price in cents

costSplitMaxPercentagenumber nullable

Cost split max percentage

costSplitStrategystring nullable

Cost split strategy

smartReassignmentboolean nullable

Smart reassignment

Example response

[
  {
    "id": "opn_WyMhHj",
    "label": "New York City Strategy",
    "allowedProviders": [
      "prv_01234567890",
      "prv_01234567891"
    ],
    "enableAutoDispatch": true,
    "providerSelectionStrategy": "cheapest",
    "reassignOnFailure": true,
    "enableMaxDeliveryFee": true,
    "maxDeliveryFeeCents": 10000,
    "costSplitMaxFixedPriceCents": 10000,
    "costSplitMaxPercentage": 0.1,
    "costSplitStrategy": "price",
    "smartReassignment": true
  }
]