Skip to main content

ShipBob API Endpoints

The ShipBob API endpoints the iPaaS.com integration uses, grouped by data type — locations, shipping methods, products, inventory, orders, and shipments — plus how authentication, pagination, and rate limits behave.

See what the ShipBob integration can do →

This article lists the ShipBob API endpoints the iPaaS.com integration uses, grouped by the data type each one works with. For every operation you will find a short description of when the integration calls it, the URL pattern, and the query parameters where they apply. It also explains how authentication, pagination, and rate limits behave so you know what to expect when the integration is running.

Throughout this article, [Base URL] stands for the ShipBob API URL you configure in your subscription settings (for example, the sandbox or production host with its version namespace). Replace it with your own value when reading an endpoint. Because you may have more than one environment, this value can differ from one subscription to the next.

Table of Contents

Authentication

The ShipBob integration signs in with OAuth. During installation you authorize iPaaS.com from your ShipBob account and select the sales channel the integration should act on. ShipBob then issues an access token that the integration presents on every request. You do not manage this token by hand — the integration stores it and sends it automatically.

  • Authorization URL: [Auth URL]/connect/authorize

  • Token URL: [Auth URL]/connect/token

[Auth URL] stands for the ShipBob authorization host you configure in your subscription settings (for example, https://auth.shipbob.com). The value can differ per environment.

When an operation is tied to a specific sales channel — for example, creating an order or resolving a product within a channel — the integration also sends your selected channel identifier with the request so ShipBob applies the operation to the correct channel.

Locations

Get All Locations: (GET)

Used during TO iPaaS.com transfers to capture your ShipBob fulfillment locations. The same call also supplies the location groups the integration derives from those locations.

[Base URL]/location

Shipping Methods

Get All Shipping Methods: (GET)

Used during TO iPaaS.com transfers to capture the shipping methods available in your ShipBob account. The results are paged.

[Base URL]/shippingmethod?Page={page}&Limit={limit}

Parameter

Description

Page

The page number to retrieve.

Limit

The maximum number of records to return per page.

Products

Get a Product by ID: (GET)

Used to retrieve a single ShipBob product by its identifier when the integration already knows which product it needs.

[Base URL]/product/{id}

Search Products by Name: (GET)

Used when resolving a product for an order line or for inventory. The integration searches ShipBob products by name to find the matching product.

[Base URL]/product?Search={name}

Parameter

Description

Search

The product name (or search term) to match.

Find Products by Reference ID: (GET)

Used when resolving a product for an order line by its reference identifier rather than by name.

[Base URL]/product?ReferenceIds={referenceId}

Parameter

Description

ReferenceIds

The reference identifier of the product to match.

Inventory

Get Inventory by ID: (GET)

Used during TO iPaaS.com transfers to capture the on-hand and fulfillable quantities for a product or product variant, identified by its inventory ID.

[Base URL]/inventory/{id}

Get Updated Inventory (Polling): (GET)

Used when the integration polls for inventory changes. It requests the orders updated since the last successful poll so it can refresh the affected inventory. The results are paged.

[Base URL]/order?LastUpdateStartDate={timestamp}&Page={page}&Limit={limit}

Parameter

Description

LastUpdateStartDate

The starting timestamp (UTC) for the update window. The integration tracks this cursor automatically between polls.

Page

The page number to retrieve.

Limit

The maximum number of records to return per page.

Orders

Create an Order: (POST)

Used during FROM iPaaS.com transfers to create an order in ShipBob from an iPaaS.com transaction. The order is created within your selected sales channel.

[Base URL]/order

The integration sends your selected channel identifier with this request so the order is created in the correct ShipBob sales channel.

Shipments

Get a Shipment: (GET)

Used to retrieve the shipment details for an order so the integration can capture tracking information into iPaaS.com.

[Base URL]/shipment/{id}

Get Orders with Tracking Updates (Polling): (GET)

Used when the integration polls for tracking updates. It requests the orders whose tracking changed since the last successful poll so it can capture the latest tracking numbers. The results are paged.

[Base URL]/order?LastTrackingUpdateStartDate={timestamp}&Page={page}&Limit={limit}

Parameter

Description

LastTrackingUpdateStartDate

The starting timestamp (UTC) for the tracking-update window. The integration tracks this cursor automatically between polls.

Page

The page number to retrieve.

Limit

The maximum number of records to return per page.

Pagination

ShipBob list endpoints use page-based pagination. You request a page by number and a page size, and ShipBob returns that slice of the results. The integration controls this for you: it sets the page number and page size on each request and walks through the pages until no more records are returned. The two parameters involved are:

Parameter

Description

Page

The page number to retrieve, starting at 1.

Limit

The maximum number of records to return per page.

Rate Limits and Concurrency

ShipBob rate-limits API calls to 150 requests per minute using a sliding window, counted per user, per application across all of the ShipBob APIs. When the limit is exceeded, ShipBob responds with HTTP status 429 (Too Many Requests) and includes an x-retry-after header (the number of seconds to wait before retrying) and an x-remaining-calls header (the number of calls still available in the current window).

Source: ShipBob Developer API — Rate Limit (https://developer.shipbob.com/rate-limit), accessed 2026-07-06.

The integration paces its requests to stay within this limit. The throttling values that govern how quickly iPaaS.com sends requests are pre-populated in your subscription settings; subscribers or their MiSP normally do not need to change them. See the Connections and Settings article for details.

Related Documents

Did this answer your question?