Configuring ShipBob as a Source
In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the ShipBob option from the list of connectors. Click Next and you’ll be prompted to add your access.1. Add account access
You’ll need a ShipBob Personal Access Token (PAT) to connect. To generate one:- Log in to your ShipBob Dashboard
- Navigate to Integrations > API Tokens
- Click Create Token and copy the generated token
- Access Token: Your ShipBob Personal Access Token (PAT).
- Channel ID: (Optional) The ShipBob channel ID to filter orders and products. You can find this in the ShipBob dashboard under channel settings.
- Start Date: (Optional) The earliest date from which records will be synced for incremental streams. Applies to orders and returns.
2. Select streams
Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.Tip: The stream can be found more easily by typing its name.Select the streams and click Next.
3. Configure data streams
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: you can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data - which is good if, for example, you want to keep every record ever fetched.
- Full table: every time the extraction happens, we’ll get the current state of the data - which is good if, for example, you don’t want to have deleted data in your catalog.
4. Configure data source
Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:- Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
- Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
5. Check your new source
You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.Streams and Fields
Below you’ll find all available data streams from ShipBob and their corresponding fields:Orders
Orders
Complete order data including shipment details, recipient information, and line items.
| Field | Type | Description |
|---|---|---|
id | integer | Unique order ID |
order_number | string | Display order number |
reference_id | string | Client-defined external reference ID |
status | string | Order status (Processing, Exception, PartiallyFulfilled, Fulfilled, Cancelled, ImportReview) |
type | string | Order type (DTC, DropShip, B2B) |
created_date | datetime | When the order was created |
purchase_date | datetime | When the purchase was made |
last_update_at | datetime | Last update timestamp (used for incremental sync) |
shipping_method | string | Selected shipping method |
gift_message | string | Gift message included with the order |
channel | object | Channel information (id, name) |
financials | object | Financial details (total_price) |
shipping_terms | object | Shipping terms (carrier_type, payment_term) |
tags | array | Order tags (name, value pairs) |
recipient | object | Recipient details (name, email, phone_number, address) |
products | array | Line items (id, sku, reference_id, gtin, upc, quantity, unit_price) |
shipments | array | Shipment details (id, status, tracking, location, measurements, products) |
Products
Products
Product catalog with variant information.
| Field | Type | Description |
|---|---|---|
id | integer | Unique product ID |
reference_id | string | External reference ID |
name | string | Product name |
sku | string | Product SKU |
created_date | datetime | When the product was created |
last_updated_timestamp | datetime | Last update timestamp |
product_type | string | Type of product |
is_case_pick | boolean | Whether the product is case-pick eligible |
is_lot | boolean | Whether lot tracking is enabled |
channel | object | Channel information (id, name) |
variants | array | Product variants (id, name, sku, barcode, gtin, upc, status, dimensions, weight, inventory_items) |
Inventory
Inventory
Inventory items with quantity levels across fulfillment centers.
| Field | Type | Description |
|---|---|---|
id | integer | Unique inventory item ID |
name | string | Inventory item name |
sku | string | SKU |
is_digital | boolean | Whether this is a digital item |
is_case_pick | boolean | Whether case-pick is enabled |
is_lot | boolean | Whether lot tracking is enabled |
is_active | boolean | Whether the item is active |
total_fulfillable_quantity | integer | Total fulfillable quantity |
total_onhand_quantity | integer | Total on-hand quantity |
total_committed_quantity | integer | Total committed quantity |
total_sellable_quantity | integer | Total sellable quantity |
total_awaiting_quantity | integer | Total awaiting quantity |
total_backordered_quantity | integer | Total backordered quantity |
total_internal_transfer_quantity | integer | Total internal transfer quantity |
total_exception_quantity | integer | Total exception quantity |
dimensions | object | Item dimensions (length, width, height, weight, units) |
fulfillment_center_quantities | array | Quantity breakdown per fulfillment center |
Returns
Returns
Return orders with inventory item details.
| Field | Type | Description |
|---|---|---|
id | integer | Unique return ID |
reference_id | string | External reference ID |
status | string | Return status (AwaitingArrival, Arrived, Processing, Completed, Cancelled) |
return_type | string | Return type (Regular, ReturnToSender) |
created_date | datetime | When the return was created |
last_updated_at | datetime | Last update timestamp (used for incremental sync) |
completed_date | datetime | When the return was completed |
tracking_number | string | Return tracking number |
original_shipment_id | integer | ID of the original shipment |
store_order_id | string | Store order ID |
fulfillment_center | object | Fulfillment center handling the return (id, name) |
inventory_items | array | Returned items (id, name, sku, quantity, action, action_reason) |
Channels
Channels
Sales channels connected to ShipBob.
| Field | Type | Description |
|---|---|---|
id | integer | Unique channel ID |
name | string | Channel name |
application_name | string | Application name |
is_active | boolean | Whether the channel is active |
Locations
Locations
ShipBob fulfillment and storage locations.
| Field | Type | Description |
|---|---|---|
id | integer | Unique location ID |
name | string | Location name |
abbreviation | string | Location abbreviation |
timezone | string | Location timezone |
is_active | boolean | Whether the location is active |
is_receiving_enabled | boolean | Whether receiving is enabled |
is_shipping_enabled | boolean | Whether shipping is enabled |
access_granted | boolean | Whether access is granted |
location_type | string | Type of location |
address | object | Location address (address1, address2, city, state, zip_code, country) |
services | array | Available services (name, enabled) |
Fulfillment Centers
Fulfillment Centers
Fulfillment center details.
| Field | Type | Description |
|---|---|---|
id | integer | Unique fulfillment center ID |
name | string | Fulfillment center name |
timezone | string | Timezone |
is_active | boolean | Whether the center is active |
is_receiving_enabled | boolean | Whether receiving is enabled |
address | object | Center address (address1, address2, city, state, zip_code, country) |
Shipping Methods
Shipping Methods
Available shipping methods.
| Field | Type | Description |
|---|---|---|
name | string | Shipping method name |
service_level | string | Service level |
carrier | string | Carrier name |
default | boolean | Whether this is the default shipping method |
Implementation Notes
- Rate Limits: ShipBob’s API allows 150 requests per minute. The connector automatically handles rate limiting by respecting the
x-retry-afterheader on 429 responses. - Incremental Sync: Orders and returns support incremental sync, using
last_update_atandlast_updated_atrespectively as replication keys. - Channel Filtering: If a
channel_idis configured, the connector sends theshipbob_channel_idheader, filtering orders and products to that specific channel.