Simulations

What Are Sandbox Simulations?

Sandbox Simulations let you:

• Test your integration with realistic, production-like data.
• Simulate actions that happen in a ShipBob facility (e.g., shipping or delivering an order).
• Spot and fix issues before they happen in real life.

Think of it as a practice run—everything works like the real thing, but no actual shipments are made.

Step 1: Set Up Your Sandbox Environment

Before running simulations, make sure your sandbox account is ready. Follow our Sandbox Setup guide to:

• Sign up for a sandbox account
• Generate an API access token (API only)
• Use the correct base URLs (API only)
• Add payment methods and inventory (if needed)

Once setup is complete, continue with the steps below to simulate fulfillment events.

Step 2: Understand How Simulations Work

There are two ways to run simulations:

API

1. Send a request to a Simulation API endpoint.
2. Get a simulation ID in response.
3. The simulation runs in the background (it might take a little time to complete).

UI Terminal

1. Open the Simulation Terminal from the sandbox dashboard.
2. Pick a workflow (e.g., fulfill-order, receive-wro, adjust-inventory).
3. Follow the interactive prompts to provide inputs and advance through stages.

Step 3: Pick an Action to Simulate

Using the API, you can simulate:

• Mark a Shipment/Order as Shipped
• Mark a Shipment/Order as Delivered

Using the UI Terminal, the following workflows are available:

• Receive WRO — Simulate receiving a warehouse receiving order.
• Fulfill Order — Simulate shipping and delivering an order.
• Adjust Inventory — Simulate inventory adjustments.

To simulate other actions, email support@shipbob.com.

Step 4: Prepare for Simulation

Requirements vary by simulation method and workflow. Make sure the relevant conditions are met before running.

Step 5: Run a Simulation

1
POST https://sandbox-api.shipbob.com/2026-01/simulate/shipment

1
{
2
  "shipment_id": 11471145,
3
  "simulation": {
4
    "action": "ShipOrder",
5
    "delay": null,
6
    "next": {
7
      "action": "DeliverOrder",
8
      "delay": 10
9
    }
10
  }
11
}

1
{
2
  "shipment_id": 11471145,
3
  "simulation": {
4
    "action": "ShipOrder"
5
  }
6
}

1
{
2
  "shipment_id": 11471145,
3
  "simulation": {
4
    "action": "DeliverOrder"
5
  }
6
}

1
{
2
  "shipment_id": 11471145,
3
  "simulation": {
4
    "action": "ShipOrder",
5
    "delay": 5,
6
    "next": {
7
      "action": "DeliverOrder",
8
      "delay": 10
9
    }
10
  }
11
}

Step 6: Check Simulation Status

Use the simulation_id returned from your request to check its progress.

Endpoint

1
GET https://sandbox-api.shipbob.com/2026-01/simulate/status/{simulation_id}

Authorization: Bearer {token}

Response (200 OK)

1
{
2
  "simulation_id": "d1cdb...ef3",
3
  "entity_id": "11471145",
4
  "entity_type": "shipment",
5
  "simulation": {
6
    "action": "ShipOrder",
7
    "status": "Success",
8
    "message": "ShipOrder",
9
    "schedule_time": "2025-06-01T14:00:00Z",
10
    "next": {
11
      "action": "DeliverOrder",
12
      "status": "Pending",
13
      "message": "DeliverOrder",
14
      "schedule_time": "2025-06-01T14:10:00Z"
15
    }
16
  }
17
}

Response Fields

• status — One of Success, Failed, Pending, or Skipped.
• schedule_time — Time the action is scheduled for (if delay was set).
• next — Nested action status (if multiple actions were simulated).

Simulation API Reference

FAQ