Authorizations
Authentication using Personal Access Token (PAT) token
Path Parameters
The simulation id
Orders
- GETGet shipping methods
- GETGet one Shipment's status timeline by Shipment Id
- GETGet all Shipments for Order
- POSTEstimate Fulfillment Cost For Order
- GETGet logs for one Shipment by Shipment Id
- GETGet logs for one Shipment by Order Id and Shipment Id
- GETGet Order Store Json
- POSTSave the Store Order Json
- GETGet one Shipment's status timeline by Order Id and Shipment Id
- GETGet one Shipment by Shipment Id
- PUTUpdate a Shipment
- GETGet one Shipment by Order Id and Shipment Id
- POSTCancel one Shipment by Shipment Id
- GETGet Order
- POSTCancel single Order by Order ID
- POSTCancel one Shipment by Order Id and Shipment Id
- GETGet Orders
- POSTCreate Order
- POSTCancel multiple Shipments by Shipment Id
- POSTUpdate Tracking Uploaded Status for Multiple Shipments by Shipment Id
Locations
Products
- GETGet Product
- PATCHUpdate a single product with Json Merge Patch functionality
- GETRetrieves List of Products based on filters provided
- POSTCreate single product to the store
- 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
- GETGet Taxonomy Parent by Id
- GETGet Taxonomies
- POSTUsed to Create a new Channel Metadata Entry for a given Variant
- GETGet Packaging Requirement
- GETGet Taxonomy by Id
Receiving
Returns
Channels
Webhooks
Inventory
Simulations
Get the status of a simulation
Get the status of a simulation
GET
/
2.0
/
simulate
/
status
/
{simulationId}
Get the status of a simulation
Copy
Ask AI
curl --request GET \
--url https://sandbox-api.shipbob.com/2.0/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/2.0/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"
}