Authorizations
Authentication using Personal Access Token (PAT) token
Path Parameters
The simulation id
Channels
Locations
Inventory
Orders
- GETGet logs for one Shipment by Order Id and Shipment Id
- GETGet one Shipment by Shipment Id
- GETGet all Shipments for Order
- GETGet one Shipment's status timeline by Order Id and Shipment Id
- GETGet Orders
- POSTCreate Order
- GETGet one Shipment by Order Id and Shipment Id
- GETGet Order
- GETGet one Shipment's status timeline by Shipment Id
- GETGet logs for one Shipment by Shipment Id
- POSTCancel one Shipment by Order Id and Shipment Id
- POSTCancel one Shipment by Shipment Id
- POSTCancel single Order by Order ID
- GETGet Order Store Json
- POSTSave the Store Order Json
- POSTUpdate Tracking Uploaded Status for Multiple Shipments by Shipment Id
- POSTCancel multiple Shipments by Shipment Id
- POSTEstimate Fulfillment Cost For Order
- GETGet shipping methods
Products
- GETGets Packaging Requirement
- PUTUpdate specific channel metadata record from a variant by channel metadata ID
- DELUsed to delete a specific channel metadata record from a variant by channel metadata ID
- POSTMigrates existing variants to a new product
- GETGets Taxonomy by Id
- GETRetrieves List of Products based on filters provided
- POSTCreate single product to the store
- POSTAdd new product variants to a product
- GETGets multiple product variants
- POSTAdds new product variants to a product
- PATCHUpdates multiple product variants
- GETGets Taxonomy
- POSTUsed to merge two or more variants together
- POSTMigrates variants to existing product
- GETGets Taxonomy Parent
- GETGets Product by Id
- DELDeletes Bundle and removes associations to related products
- PATCHUpdate a single product with Json Merge Patch functionality
- POSTCreate a new Channel Metadata Entry for a given Variant
Receiving
Returns
Billing
Simulations
Get the status of a simulation
Get the status of a simulation
GET
/
2025-07
/
simulate
/
status
/
{simulationId}
Get the status of a simulation
Copy
Ask AI
curl --request GET \
--url https://sandbox-api.shipbob.com/2025-07/simulate/status/{simulationId} \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"entity_id": "string",
"entity_type": "string",
"simulation": {
"action": "string",
"message": "string",
"next": {},
"schedule_time": "2019-08-24T14:15:22Z",
"status": "string"
},
"simulation_id": "df0e679f-936d-49a6-bcd5-04f5809bd3f2"
}⌘I
Get the status of a simulation
Copy
Ask AI
curl --request GET \
--url https://sandbox-api.shipbob.com/2025-07/simulate/status/{simulationId} \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"entity_id": "string",
"entity_type": "string",
"simulation": {
"action": "string",
"message": "string",
"next": {},
"schedule_time": "2019-08-24T14:15:22Z",
"status": "string"
},
"simulation_id": "df0e679f-936d-49a6-bcd5-04f5809bd3f2"
}