My Account

Simulator Documentation

The simulator requests allow the testing and development of requests that involve replicating actions involving a driver.

During testing, some actions cannot be directly represented. For example, a driver cannot accept a delivery. The simulator requests allow replicating actions involving a driver, such as a driver accepting a delivery.

Simulator requests may only be used with a sandbox account.

The following simulator requests are available:

Request NameEndpointMeaning
Get Available StepsPOST /available-stepThis simulator request lists actions that can be taken for a delivery.
Execute Next StepsPOST /available-step/executeThis simulator request executes an action representing an actual driver. This request returns the next set of actions that can be taken for a delivery.