How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ShipBob subpackage_simulations API

The subpackage_simulations API from ShipBob — 2 operation(s) for subpackage_simulations.

ShipBob subpackage_simulations API is one of 10 APIs that ShipBob publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, release notes, and rate-limit docs.

This API exposes 2 operations across 2 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.shipbob.com, https://sandbox-api.shipbob.com.

2 operations 2 paths 7 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.shipbob.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ShipBob subpackage_simulations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (PAT).

  • PAT — Authentication using Personal Access Token (PAT) token or OAuth2

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_simulations 2
POST
/2026-01/simulate/shipment
Simulates Shipment
simulates-shipment 1 param body → 200
GET
/2026-01/simulate/status/{simulationId}
Get Simulation Status
get-simulation-status 2 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Simulation.actionStatusResponseModel (5 properties), Simulation.simulationStatusResponseModel (4 properties), Simulation.simulationModel (3 properties), Simulation.orderSimulationRequestModel (2 properties). Each schema is shown below with its type and property counts.

Simulation.simulationResponseModel
object
Response returned after submitting a simulation request.
2 properties
SimulationActionStatusResponseModelAction
string
The name of the action performed in the simulation (for example: ShipOrder, DeliverOrder).
Simulation.actionStatusResponseModel
object
Represents the current status of a simulation action, optionally including a chained next action status.
5 properties
Simulation.orderSimulationRequestModel
object
Request payload for running a simulation against a specific shipment.
2 properties 2 required
Simulation.simulationStatusResponseModel
object
Provides the current status for a simulation run, including the target entity and the action execution chain.
4 properties
SimulationSimulationModelAction
string
The simulation action to perform.
Simulation.simulationModel
object
Defines a simulation action to run, with an optional delay and an optional next action to allow chaining.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shipbob-subpackage-simulations-api-openapi.yml Raw ↑

Other APIs ShipBob publishes across the network.

ShipBob subpackage_billing API
ShipBob subpackage_channels API
ShipBob subpackage_inventory API
ShipBob subpackage_locations API
ShipBob subpackage_orders API
ShipBob subpackage_products API
ShipBob subpackage_receiving API
ShipBob subpackage_returns API
ShipBob subpackage_webhooks API
Where this information came from

This is an independent, third-party profile of ShipBob subpackage_simulations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.