Skip to main content
POST
Start an automatic simulation

Authorizations

Authorization
string
header
required

A business-bound HaulStow API key. Send Authorization: Bearer hsg_live_key_... to the live server or a hsg_test_key_... key to the sandbox server. Never expose this key in a browser.

Headers

X-Request-ID
string

Optional caller correlation ID. Use 1–128 ASCII letters, digits, ., _, -, or :. Invalid values are replaced. The accepted/generated value is returned in the response.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]+$
Idempotency-Key
string
required

A unique key for this logical mutation. Retained for 24 hours.

Required string length: 8 - 255

Path Parameters

delivery_id
string
required
Pattern: ^dlv_[a-f0-9]{32}$
Example:

"dlv_3f1a821cdb58498cbb52f4706545a089"

Body

application/json

Sandbox only. Makes the delivery play out a scenario by itself.

scenario
enum<string>
required
Available options:
delivered,
cod_settled,
cod_partial_collection,
cancelled_before_assignment,
cancelled_after_assignment,
failed,
failed_then_retried,
outsourced
Example:

"failed_then_retried"

step_delay_seconds
integer
default:5

The wait before each step.

Required range: 1 <= x <= 60

Response

Simulation started. The delivery is returned with its simulation object.

success
boolean
required
statusCode
enum<integer>
required
Available options:
200,
201
message
string
required
data
object
required