Skip to main content
GET
Read this merchant's sandbox readiness checklist

Authorizations

dh_at
string
cookie
required

Opaque httpOnly browser session cookie issued by the existing human authentication flows. Browsers send it automatically; Swagger UI cannot and does not persist or manufacture it.

Response

Tenant-bound readiness and routable fixture coordinates

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

Use this fixture city code in price-estimate and shipment requests.

Allowed value: "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