Skip to main content
POST
Apply a sandbox scenario

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials.

Headers

Idempotency-Key
string
required

A unique key for this logical write.

Required string length: 8 - 255
X-Request-Id
string

A caller-supplied request identifier for support.

Required string length: 1 - 255

Path Parameters

order_id
string
required

The order identifier. Stable Bahn order identifier used in every order resource path.

Pattern: ^ord_[a-z0-9]+$

Body

application/json

Scenario to apply to one sandbox order.

scenario
enum<string>
required

Named state change to apply. Its current-state precondition must be satisfied.

Available options:
pickup_readiness_confirmed,
pickup_approach_started,
pickup_nearby,
pickup_completed,
delivery_eta_changed,
inspection_completed,
files_published,
tracking_available,
tracking_unavailable,
tracking_paused,
delivery_completed,
cancelled
occurred_at
string<date-time>

Optional event time for deterministic tests. Defaults to the current time.

Response

The sandbox applied the scenario.

Applied scenario and the resulting current order.

scenario
enum<string>
required

Scenario that was applied.

Available options:
pickup_readiness_confirmed,
pickup_approach_started,
pickup_nearby,
pickup_completed,
delivery_eta_changed,
inspection_completed,
files_published,
tracking_available,
tracking_unavailable,
tracking_paused,
delivery_completed,
cancelled
order
object
required

Current order after the scenario.