API ReferenceSimulations

Get Simulation Status

View as Markdown
Get the detailed status of a simulation to see its current state and information.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

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

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.