ShipBob

Setup

Create a Personal Access Token in the ShipBob dashboard under Integrations → API Tokens. Add the connection under Settings -> Connections. Saving verifies it with a read-only test call.

Configuration

Field	Required	Description
Channel ID	No	Optional. Scopes requests to one sales channel.

Operations

All operations are read-only. Apps declare the ones they use per connection; see Using connections in apps.

Operation	Description
`channels.list`	List sales channels the token can access. The cursor is an opaque token; pass it back as cursor.
`orders.list`	List orders with optional date, tracking, and reference filters. The cursor is the next page number; pass it back as page.
`order.get`	Fetch one order by id.
`order.shipments`	List the shipments of one order.
`shipment.get`	Fetch one shipment by id.
`inventory.list`	List inventory items (the item catalog, not stock counts). The cursor is an opaque token; pass it back as cursor.
`inventory.get`	Fetch one inventory item by id.
`products.list`	List products with their variants. The cursor is an opaque token; pass it back as cursor.
`product.get`	Fetch one product by id.
`returns.list`	List returns with optional date and status filters. The cursor is the next page number; pass it back as page.
`receiving.list`	List warehouse receiving orders (inbound inventory). The cursor is the next page number; pass it back as page.
`locations.list`	List fulfillment center locations.

Get started

Guides

Platform services

Connections

Reference

Setup

Configuration

Operations

​Setup

​Configuration

​Operations

Setup

Configuration

Operations