Skip to main content
GET
/
2026-01
/
simulate
/
status
/
{simulationId}
Get Simulation Status 
curl --request GET \
  --url https://sandbox-api.shipbob.com/2026-01/simulate/status/{simulationId} \
  --header 'Authorization: Bearer <token>'
{
  "entity_id": "string",
  "entity_type": "string",
  "simulation": {
    "action": "string",
    "message": "string",
    "next": {},
    "schedule_time": "2019-08-24T14:15:22Z",
    "status": "string"
  },
  "simulation_id": "df0e679f-936d-49a6-bcd5-04f5809bd3f2"
}

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Path Parameters

​
simulationId
string<uuid>
required

The simulation id

Response

200 - application/json

The simulation status

Provides the current status for a simulation run, including the target entity and the action execution chain.

​
entity_id
string | null

The identifier of the entity the simulation is associated with (for example: shipment id).

​
entity_type
string | null

The type of entity the simulation is associated with (for example: Order).

​
simulation
object

The current status of the simulation action(s), including any chained next actions.

​
simulation_id
string<uuid> | null

The unique identifier of the simulation run.