Skip to main content
POST
/
2026-01
/
simulate
/
shipment
Simulates Shipment
curl --request POST \
  --url https://sandbox-api.shipbob.com/2026-01/simulate/shipment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shipment_id": "string",
  "simulation": {
    "action": "string",
    "delay": 0,
    "next": {}
  }
}
'
{
  "message": "string",
  "simulation_id": "string"
}

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Body

application/json

Order Simulation Request Model

Request payload for running a simulation against a specific shipment.

​
shipment_id
string | null
required

The ShipBob shipment id the simulation should target.

Minimum string length: 1
​
simulation
object
required

The simulation action definition, optionally chained with subsequent actions.

Response

Existing registration

Response returned after submitting a simulation request.

​
message
string | null

Optional message about the submitted simulation.

​
simulation_id
string | null

The unique identifier of the simulation run.

Last modified on February 12, 2026