Simulates Shipment | ShipBob Developer API

Simulation shipments in the ShipBob sandbox environment. Learn more about sandbox simulations.

This endpoint is only available on sandbox.

Simulation shipments 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

Request

Order Simulation Request Model

shipment_idstring or nullRequired>=1 character

The ShipBob shipment id 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.

1	import requests
2
3	url = "https://api.shipbob.com/2026-01/simulate/shipment"
4
5	payload = {
6	"shipment_id": "string",
7	"simulation": {
8	"action": "ShipOrder",
9	"delay": 0,
10	"next": {}
11	}
12	}
13	headers = {
14	"Authorization": "Bearer <token>",
15	"Content-Type": "application/json"
16	}
17
18	response = requests.post(url, json=payload, headers=headers)
19
20	print(response.json())