ShipBob
Create Instance
Connect a new ShipBob integration instance. The provided ShipBob Personal Access Token is stored encrypted, a per-instance webhook signing secret is generated, webhook subscriptions are registered, and an initial sync of fulfillment centers, shipping methods, products, and inventory is queued.
Test Connection
Validate an unsaved set of ShipBob credentials before creating an instance. Never returns an error status for bad credentials — a failure is reported as connected=false with a message. On success it returns the channels available to the token.
Get Instance
Retrieve a single ShipBob integration instance with its connection metadata and behavior settings. Sensitive credentials (the API token and webhook secret) are never returned.
Update Instance
Partially update a ShipBob integration instance. Only the sections present in the request are applied; omitted sections keep their current values. The environment cannot be changed after connect. Leave api_token out to keep the stored token.
Delete Instance
Disconnect a ShipBob integration instance. Webhook subscriptions are removed at ShipBob and all mirrored data is deleted in the background; the request returns immediately.
Test Saved Connection
Re-validate the stored credentials for an existing instance and list the channels available to the token. Never returns an error status for bad credentials.
Get Dashboard Metrics
Aggregate KPI counters and sync/webhook health for the instance dashboard.
List Orders
Paginated, filterable, sortable list of ShipBob orders for the instance (the provider mirror of a fulfillment order).
Get Order
Retrieve a single ShipBob order by its ShipBob id, scoped to the instance.
Get Raw Order Data
Fetch the raw ShipBob order payload live from ShipBob (fetch-on-demand, never persisted).
Sync Orders
Queue a background order sync and return the tracked job id so progress can be followed.
Get Order Sync Info
Metadata for the order sync/refresh flow: the latest synced order and the configured sync start date.
Search Orders
Live provider-side order search by reference id or order number (used by the refresh/search flow). Returns raw ShipBob order rows.
Refresh Order
Live-fetch a single order from ShipBob by its ShipBob id and upsert it locally.
List Shipments
Paginated, filterable, sortable list of ShipBob shipments for the instance (one ship event each).
Get Shipment
Retrieve a single ShipBob shipment by its ShipBob shipment id, scoped to the instance.
Get Raw Shipment Data
Fetch the raw ShipBob shipment payload live from ShipBob (fetch-on-demand, never persisted).
Get Shipment Timeline
Fetch the shipment's event timeline live from ShipBob.
Sync Shipments
Queue a background shipment sync and return the tracked job id.
List Products
Paginated, filterable, sortable list of ShipBob products (one row per variant) with their SKU product mapping state.
Get Product
Retrieve a single ShipBob product by its local row id, scoped to the instance.
Get Raw Product Data
Return the persisted raw ShipBob product payload (ShipBob has no single-product fetch endpoint).
Sync Products
Queue a background product sync and return the tracked job id.
Map Product
Set or clear the SKU product mapping for a ShipBob product. Pass null to unmap.
Push Product
Push a single SKU product to ShipBob (weight in ounces, dimensions in inches).
Bulk Push Products
Queue a background bulk push of the given ShipBob product rows to ShipBob.
List Inventory Levels
Paginated, filterable, sortable list of ShipBob inventory levels (per inventory item x fulfillment center).
Sync Inventory
Queue a background inventory sync and return the tracked job id.
List Discrepancies
List on-hand discrepancies between ShipBob fulfillable quantities and SKU on-hand for mapped products (mapped warehouses only).
Create Stock Take from Discrepancies
Create an adjustment-mode stock take from selected inventory discrepancies against the SKU warehouse mapped to this instance's fulfillment centers.
List Fulfillment Centers
List all ShipBob fulfillment centers for the instance with their SKU warehouse mapping.
Sync Fulfillment Centers
Queue a background fulfillment center sync and return the tracked job id.
Save Fulfillment Center Mappings
Bulk save fulfillment center to SKU warehouse mappings.
List Shipping Methods
List ShipBob shipping methods with their mapping state, plus the active SKU shipping methods available to map to.
Sync Shipping Methods
Queue a background shipping method sync and return the tracked job id.
Map Shipping Method
Set or clear the SKU shipping method for a ShipBob shipping method. Omit or null shipping_method_id to unmap.
Auto-Match Shipping Methods
Auto-match still-unmapped ShipBob shipping methods to SKU shipping methods by normalized name.
Bulk Map Shipping Methods
Map many ShipBob shipping methods to one SKU shipping method (or clear when omitted) in one call.
Import Shipping Method Mappings
Import shipping method mappings from a CSV file.
Export Shipping Method Mappings
Export the shipping method mappings as a re-importable CSV file download.
List Returns
Paginated, filterable, sortable list of ShipBob returns for the instance.
Get Return
Retrieve a single ShipBob return by its ShipBob return id, scoped to the instance.
Get Raw Return Data
Fetch the raw ShipBob return payload live from ShipBob (fetch-on-demand, never persisted).
Sync Returns
Queue a background return sync and return the tracked job id.
List Receiving Orders
Paginated, filterable, sortable list of ShipBob receiving orders (WROs — inbound shipments to a fulfillment center).
Get Receiving Order
Retrieve a single ShipBob receiving order (WRO) by its ShipBob receiving id, scoped to the instance.
Get Raw Receiving Order Data
Fetch the raw ShipBob receiving order payload live from ShipBob (fetch-on-demand, never persisted).
Sync Receiving Orders
Queue a background receiving order sync and return the tracked job id.
Get Box Labels
Retrieve the box-label PDF payload for a single receiving order (WRO) from ShipBob.
List Webhook Subscriptions
List the ShipBob webhook subscriptions registered for the instance (one per topic).
Subscribe Webhooks
Queue a job to (re-)subscribe to every ShipBob webhook topic for the instance.
List Webhook Events
Paginated, filterable, sortable log of inbound ShipBob webhook events for the instance.
Replay Webhook Event
Re-process a stored webhook event idempotently (queued in the background).