Portal/Instance Identifier: {Instance Identifier}
NOTE: The {Instance Identifier}
shown above is just a placeholder - replace it with your actual ShipBob API URL. Since you might have multiple test environments, this identifier will be different for each one.
Base URLs
Sandbox/Test:
https://sandbox-api.shipbob.com/1.0
Production/Live:
[Production Base URL]
Auth URL
https://auth.shipbob.com
This URL is for the actual ShipBob Auth URL. Since there can be multiple test environments, the value of the URL may vary per instance.
Table of Contents
Location Endpoints
Get All Locations: (GET)
[Base URL]/location
Order Endpoints
Get a [Entity Name]: (GET)
[[Base URL]/order
Product Endpoints
Get a Product: (GET)
[Base URL]/product/{id}
Get All Products: (GET)
[Base URL]/products
Inventory Endpoints
Get an Inventory: (GET)
[Base URL]/inventory/{id}
Get Inventory by Last Update Date: (GET)
[Base URL]/order? LastUpdateStartDate={LastUpdateStartDate}&Page={page}&Limit={limit}
Get Product By Inventory Id: (GET)
[Base URL]/product?Search={InventoryId}
Shipment Endpoints
Get Shipment: (GET)
[Base URL]/shipment/{id}
Get Order by Last Tracking Update Start Date: (GET)
[Base URL]/order?LastTrackingUpdateStartDate={LastTrackingUpdateStartDate}&Page={page}&Limit={limit}
Process [Transaction Type]: (POST)
[Base URL]/[API Path]/[endpoint]/[action]
Shipment Method Endpoints
Get Shipment Method: (GET)
[Base URL]/shippingmethod?Page=2147483647&Limit=250
Authentication/OAuth Endpoints
Get Access Token: (POST)
[Auth URL]/connect/token
Utility/Generic Endpoints
Get Product By Reference Id: (GET)
[Base URL]/product?Search={name}
Get Product By Name: (GET)
[Base URL]/product?ReferenceIds={ReferenceId}