← Tools Reference

ShipBob

ShipBob integration (Productivity, Data). Imported from open-connector.

API key5 toolshttps://api.shipbob.com
GET
ship_bob_list_channels
List ShipBob channels available to the authenticated Personal Access Token.

/channel

GET
ship_bob_list_inventory_levels
List ShipBob inventory levels with optional item and product filters.

/inventory-level

6 parameters
ParamTypeRequiredDescription
searchBystringoptionalSearch by inventory id, inventory name, or SKU.
inventoryIdsarrayoptionalSpecific ShipBob inventory item ids to retrieve.
isActivebooleanoptionalWhether to return only active or inactive inventory items.
isDigitalbooleanoptionalWhether to return only digital or physical inventory items.
pageSizeintegeroptionalThe maximum number of ShipBob records to return.
sortBystringoptionalThe ShipBob field expression used to sort results, such as Name or -total_on_ha…
GET
ship_bob_get_inventory_level
Get aggregated ShipBob inventory levels for one inventory item.

/inventory-level/{inventoryId}

1 parameter
ParamTypeRequiredDescription
inventoryIdintegerrequiredThe ShipBob inventory item id to retrieve.
GET
ship_bob_list_products
List ShipBob products with optional catalog filters.

/product

21 parameters
ParamTypeRequiredDescription
searchstringoptionalSearch products by name, SKU, inventory id, or product id.
barcodestringoptionalA barcode associated with a product variant.
barcodesarrayoptionalBarcodes associated with product variants.
categoryIdsarrayoptionalShipBob category ids associated with products.
channelIdsarrayoptionalShipBob channel ids associated with product variants.
hasDigitalVariantsbooleanoptionalWhether products have digital variants.
hasVariantsbooleanoptionalWhether products have variants.
inventoryIdintegeroptionalA ShipBob inventory id associated with a product variant.
isInventorySyncEnabledbooleanoptionalWhether inventory sync is enabled for variants.
lastUpdatedTimestampstringoptionalReturn products updated since this timestamp.
namestringoptionalSearch products or variants by name.
onHandbooleanoptionalWhether products have inventory on hand.
productIdintegeroptionalA ShipBob product id to filter by.
productTypestringoptionalA ShipBob product type to filter by.
sellerSkustringoptionalA seller SKU query.
skustringoptionalA ShipBob SKU query.
variantIdintegeroptionalA ShipBob variant id to filter by.
variantStatusstringoptionalA ShipBob variant status to filter by.
pageSizeintegeroptionalThe maximum number of ShipBob records to return.
sortBystringoptionalThe ShipBob product field used to sort results.
sortOrderstringoptionalThe ShipBob product sort order.
GET
ship_bob_list_locations
List ShipBob fulfillment network locations.

/location

3 parameters
ParamTypeRequiredDescription
includeInactivebooleanoptionalWhether inactive ShipBob locations should be included.
receivingEnabledbooleanoptionalWhether to return only receiving-enabled locations.
accessGrantedbooleanoptionalWhether to return only locations granted to this merchant.