Skip to main content
POST
Reset only the calling merchant's sandbox integration fixtures

Authorizations

Authorization
string
header
required

OAuth 2.0 client-credentials flow for external machine-to-machine integrations.

Response

Current readiness after reset

generation
integer
required
Required range: x >= 1
canCreateShipment
boolean
required
nextShipmentDispatchHeld
boolean
required

True when the next sandbox shipment will remain before any driver offer; consumed atomically by that creation.

branchCode
string
required
Allowed value: "SANDBOX_BRANCH"
pickupLocationCode
string
required
Allowed value: "SANDBOX_PICKUP"
pickup
object
required
delivery
object
required
destinationCityCode
string
required

Derived fixture coverage context; shipment requests need only coordinates.

Allowed value: "SANDBOX_RUH"
sandboxDriverPhone
string
required

Sandbox-only driver OTP identity used to progress the real canonical driver lifecycle.

Pattern: ^05[0-9]{8}$
prerequisites
object[]
required