USusenash
Dispatch Strategies

Evaluate dynamic dispatch

Changed on

Evaluate dispatch rules and rank providers without creating a job or order.

post/v1/dispatch/evaluate

Request

Request body

pickupAddressstring nullable

The full pickup address in one line. Will be geocoded to lat/lng if pickupLat/pickupLng not provided.

pickupLatnumber nullable

The pickup latitude coordinate.

pickupLngnumber nullable

The pickup longitude coordinate.

pickupAddressCitystring nullable

The city of the pickup address.

pickupAddressStatestring nullable

The state of the pickup address.

pickupAddressZipstring nullable

The zip or postal code of the pickup address.

pickupAddressCountrystring nullable

The ISO 3166-1 alpha-2 country code of the pickup address.

pickupBusinessNamestring nullable

Pickup business name.

dropoffAddressstring nullable

The full dropoff address in one line. Will be geocoded to lat/lng if dropoffLat/dropoffLng not provided.

dropoffLatnumber nullable

The dropoff latitude coordinate.

dropoffLngnumber nullable

The dropoff longitude coordinate.

dropoffAddressCitystring nullable

The city of the dropoff address.

dropoffAddressStatestring nullable

The state of the dropoff address.

dropoffAddressZipstring nullable

The zip or postal code of the dropoff address.

dropoffAddressCountrystring nullable

The ISO 3166-1 alpha-2 country code of the dropoff address.

dropoffBusinessNamestring nullable

Dropoff business name.

optionsGroupIdstring nullable

If provided, skip dispatch rule evaluation and use this options group directly.

Response

OK

strategystring nullable

Changes