API ReferenceSimulations

Simulates Shipment

View as Markdown
Simulation of shipment action endpoint.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Request

Order Simulation Request Model
shipment_idstring or nullRequired>=1 character
The ShipBob shipment identifier the simulation should target.
simulationobjectRequired
The simulation action definition, optionally chained with subsequent actions.

Response

Existing registration
messagestring or null
Optional message about the submitted simulation.
simulation_idstring or null
The unique identifier of the simulation run.