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 pull of every entity is queued: fulfillment centers, shipping methods, products and inventory always; orders (back to settings.sync_start_date), returns and receiving orders when their settings.auto_sync toggle is on.
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.
Get Activity Log
Paginated activity for the connection — instance-level configuration and connection changes plus activity for every order belonging to the instance. Ordered newest-first.
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 SKU.io row id (as returned by the list endpoint), scoped to the instance.
Get Raw Order Data
Fetch the raw ShipBob order payload live from ShipBob (fetch-on-demand, never persisted).
Get Order Activity Log
Paginated activity-log entries for a single order — the record of changes to the order (created, updated, deleted), the user who made each change, and a properties payload with the changed attributes. Ordered newest-first.
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 modal, read from SKU.io's synced orders (no ShipBob call): `latest_order_number` / `latest_order_date` are the synced order with the newest purchase date, `total_orders` is how many orders are synced for this instance, plus the configured sync start date.
Search Orders
Live provider-side order search for the refresh/search modal: matches `query` as a ShipBob reference id first, then as an order number. Returns the raw ShipBob order rows (empty array when nothing matches), each with `exists_in_database` — true when SKU.io already holds that ShipBob order, so the search dialog offers Update instead of Download.
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 SKU.io row id (falling back to the 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.
Refresh Shipment
Live-fetch one shipment from ShipBob and upsert the stored copy, then return the refreshed record. Use it to bring a single shipment up to date without running a full shipment sync.
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.io product mapping state.
Get Product
Get a single ShipBob product by id, scoped to the instance.
Get Raw Product Data
The stored raw provider payload for one product, with the timestamp of when it was last refreshed. Run a product sync to refresh it.
Get Product Mapping Candidates
The SKU.io products the auto-matcher considers for one ShipBob product: every product whose SKU or barcode equals the ShipBob product's barcode, UPC, GTIN or SKU, with the identifiers it shares (`matched_on`). A product with more than one candidate is flagged Needs Review instead of being mapped; the mapping dialog lists these for a one-click pick. 404 for a product of another connection.
Get Products Summary
Aggregate counts of ShipBob products by mapping state, plus when the product catalog was last synced.
Sync Products
Queue a background product sync and return the tracked job id. The sync runs asynchronously.
Auto-Match Products
Auto-match still-unmapped ShipBob products to SKU.io products by barcode, UPC, GTIN, or SKU. When an identifier matches more than one SKU.io product, the ShipBob product is flagged needs_review instead of being mapped.
Map Product
Map a ShipBob product to the SKU.io product it represents.
Unmap Product
Remove the SKU.io product mapping from a ShipBob product so it returns to the unmapped queue.
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 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.
List Mappable Warehouses
SKU.io warehouses a ShipBob fulfillment center may be mapped to — exactly those the mapping save accepts: Direct warehouses on Manual (or no) fulfillment (adopted into this instance's 3PL warehouse on save) and warehouses already bound to this instance. Other 3PL / shipping-provider, FBA/AWD and supplier warehouses, and archived warehouses, are excluded; warehouses an FC of this instance is already mapped to are always included. Unpaginated, ordered by name.
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. Good rows apply; each rejected row is reported in `data.errors` as 'Line N: …' (the header is line 1). Blank lines are skipped and a UTF-8 BOM (Excel 'CSV UTF-8') is tolerated.
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 SKU.io row id (falling back to the 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 SKU.io row id (falling back to the 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
Download the box labels for a single receiving order (WRO) — one label per box/pallet, proxied live from ShipBob (`GET /receiving/{id}/labels`). `{receiving}` is the ShipBob WRO id.
List Bills
List ShipBob billing transactions (every charge, credit and payment ShipBob billed) with where each fee was attributed: a sales order, a product (storage), a purchase order (receiving) or the unattributed bucket. Same shape as the Trackstar bills list: charge_type is the ShipBob fee name.
Get Bill
Get one ShipBob billing transaction with its raw ShipBob payload, the attribution resolution trace (which lookup matched or failed and why), its fee mapping and the financial lines it wrote.
Void Bill
Mark a billing transaction void — use it when ShipBob dropped a charge, since no later sync will report the removal. Its attribution is removed (order or purchase order cost lines deleted, its monthly cost entry rebuilt, billed freight re-applied to the fulfillment, the order's margin recalculated) and it is left excluded with reason manually_voided. Re-syncs and re-attribution never touch a voided transaction until it is un-voided. Returns the updated bill.
Unvoid Bill
Undo a manual void: the billing transaction returns to pending and is attributed again immediately. Returns the updated bill.
Get Bills Summary
Totals for a charge-date range: per-fee rows in the same shape as the Trackstar bills summary (charge_type, total_amount, bill_count, currency_code, plus share of the billed cost), the attribution breakdown (on orders, on products, on purchase orders, pending, unattributed, excluded payments, unattributed by reason, billed-vs-estimated freight variance) and the unattributed work queue grouped by reason and sales channel with a suggested action.
List Bill Fee Types
List every ShipBob fee name seen in billing transactions or the fee mapping (the equivalent of Trackstar's charge types).
List Bill Reference Types
List the reference types billing transactions point at (the equivalent of Trackstar's object types).
List Bill Sales Channels
List the distinct ShipBob sales channels (e.g. Shopify, Ulta, Nordstrom) that appear on billing transactions — the options for the sales_channel filter.
Sync Bills
Queue a background sync of ShipBob billing transactions and invoices, followed by attribution of new, changed and still-pending fees. Without from_date the run re-reads the last 14 days (or 48 hours before the previous sync, whichever is earlier); with from_date it backfills from that date (never before the billing start date) in 7-day windows. Returns the tracked job id. The ShipBob token needs the billing_read scope.
Re-attribute Bills
Queue re-attribution of ShipBob billing transactions: the given transaction ids, every transaction of one fee name, or (when neither is sent) every transaction since the billing start date. Previous targets are removed and rebuilt, so a re-run never double counts. Returns the tracked job id.
List Billing Invoices
List ShipBob invoices with reconciliation columns: ShipBob's amount, the sum and count of member transactions, how much is attributed / unattributed / excluded / pending, the variance, a reconciliation status (reconciled when |variance| < 0.01, variance, or awaiting_transactions), a shipbob_url deep link, and accounting_posting: status (posted, draft, pending, blocked, not_posted, or disabled when the instance does not post invoices or the invoice is a Payment), label ('Off' when posting is switched off for the instance; 'Not posted' for a Payment, which is never posted), error (why posting is blocked, e.g. a locked accounting period), journal_entry_id, journal_entry_status, posted_at and reference.
List Fee Mappings
List the instance's ShipBob fee mapping: every fee name with its family, treatment (order_freight, order_fee, return_fee, product_storage, po_receiving, unattributed, exclude), the cost line type or monthly cost entry type it lands on, a needs_review flag for newly seen fees, and 30-day usage.
Update Fee Mapping
Re-point one ShipBob fee. Saving bumps the mapping version and, when billing is enabled and the fee has transactions, queues re-attribution of that fee's transactions. Returns the saved mapping plus how many transactions (and how much) the change touches.
List Webhook Subscriptions
List the ShipBob webhook subscriptions registered for the instance (one per topic).
Subscribe Webhooks
Queues a background job to (re-)subscribe to every ShipBob webhook topic for this instance, then returns immediately. The instance's existing subscription rows are flagged `pending`; poll List Webhook Subscriptions to see each topic settle to `active` or `failed`.
List Webhook Events
Paginated, filterable, sortable log of inbound ShipBob webhook events for the instance.
Get Webhook Event
A single stored ShipBob webhook event with its full payload — what the events list's 'View payload' dialog loads. Scoped to the instance; `{event}` is the event's SKU.io id.
Replay Webhook Event
Re-process a stored webhook event idempotently (queued in the background).