Get Simulation Status | ShipBob Developer API

Get the status of a simulation in the ShipBob sandbox environment. Learn more about sandbox simulations.

This endpoint is only available on sandbox.

Get the status of a simulation in the ShipBob sandbox environment. Learn more about [sandbox simulations](/sandbox/simulations). <Warning>This endpoint is **only available** on sandbox.</Warning>

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

Path parameters

simulationIdstringRequiredformat: "uuid"

The simulation id

Response

The simulation status

entity_idstring or null

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

entity_typestring or null

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

simulationobject or null

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

simulation_idstring or nullformat: "uuid"

The unique identifier of the simulation run.

1	import requests
2
3	url = "https://api.shipbob.com/2026-01/simulate/status/simulationId"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"entity_id": "string",
3	"entity_type": "string",
4	"simulation": {
5	"action": "ShipOrder",
6	"message": "string",
7	"next": {},
8	"schedule_time": "2019-08-24T14:15:22Z",
9	"status": "string"
10	},
11	"simulation_id": "df0e679f-936d-49a6-bcd5-04f5809bd3f2"
12	}