ShipBob Component
Shipbob offers an end to end fulfillment services for Ecommerce vendors.
Component key: shipbobDescription
Shipbob offers an end to end fulfillment services for Ecommerce vendors.
Use the Shipbob component to manage orders, shipments, labels, and more.
Connections
ShipBob Personal Access Token
If you're building a single-user custom integration, you can use the Personal Access Token (PAT) method. This generates a ready-to-use bearer-type token with full access to the merchant's account.
You can generate credentials from the ShipBob dashboard.
For Production Environment, click here. For Sandbox Environment, click here.
When you request your first PAT, ShipBob automatically generates an application (called "SMA" or single-merchant application) and channel to house all your future PATs. You can request as many as you like, and revoke them at any time.
NOTE: These tokens do not expire, so be extremely cautious when sharing them.
Your PAT should automatically have read and write access to the entire ShipBob account.
To use your PAT, just provide the token as an Authorization header formatted like this:
bearer [your_api_token]
First you should use your PAT to hit the GET Channel endpoint, so you can use your channel ID in the headers of subsequent API calls. Your response will look like this:
Triggers
Webhook
Receive and validate webhook requests from ShipBob for webhooks you configure. | key: webhook
Data Sources
Fetch Fulfillment Centers
Fetch an array of Fulfillment Centers | key: fulfillmentCenters | type: picklist
Data Source Payload
{
"result": [
{
"label": "Cicero (IL)",
"key": "0"
},
{
"label": "5900 W Ogden Ave Suite 100 / USA, IL, Cicero",
"key": "47012"
}
]
}
Fetch Inventory
Fetch an array of Inventories | key: inventory | type: picklist
Data Source Payload
{
"result": [
{
"label": "TShirtBlueM",
"key": "0"
},
{
"label": "Medium Blue T-Shirt",
"key": "47012"
}
]
}
Fetch Locations
Fetch an array of locations | key: locations | type: picklist
Data Source Payload
{
"result": [
{
"label": "Cicero (IL)",
"key": "0"
},
{
"label": "Other",
"key": "47012"
}
]
}
Fetch Products
Fetch an array of Products | key: products | type: picklist
Data Source Payload
{
"result": [
{
"label": "TShirtBlueM",
"key": "0"
},
{
"label": "Other",
"key": "47012"
}
]
}
Actions
Cancel Order
Cancel an existing Order by Order ID | key: cancelOrder
Cancel Shipments
Cancel multiple Shipments by Shipment ID | key: cancelShipment
Cancel Warehouse Receiving Order
Cancels a Warehouse Receiving Order by Order ID | key: cancelWarehouseReceivingOrder
Create Order
Create a new Order | key: createOrder
Create Warehouse Receiving Order
Create a new Warehouse Receiving Order | key: createWarehouseReceivingOrder
Create Webhook
Creates a new Webhook | key: createWebhook
Delete All Instanced Webhooks
Delete all webhooks that point to a flow in this instance | key: deleteAllWebhooks
Delete Webhook
Delete a Webhook by Webhook ID | key: deleteWebhook
Get a list of Inventory Items by Product ID
Retrieve a list of Inventory Items by their Product ID | key: listByProductId
Output Example Payload
{
"data": [
{
"inventoryId": 0,
"name": "Medium Blue T-Shirt",
"isDigital": true,
"isCasePick": true,
"isLot": true,
"dimensions": {
"weight": 0,
"length": 0,
"width": 0,
"depth": 0
},
"totalFulfillableQuantity": 0,
"totalOnHandQuantity": 0,
"totalCommitedQuantity": 0,
"totalSellableQuantity": 0,
"totalAwaitingQuantity": 0,
"totalExceptionQuantity": 0,
"totalInternalTransferQuantity": 0,
"totalBackorderedQuantity": 0,
"isActive": true,
"fulfillableQuantityByFulfillmentCenter": [
{
"fulfillmentCenterId": 0,
"name": "Cicero",
"fulfillableQuantity": 0,
"onHandQuantity": 0,
"committedQuantity": 0,
"awaitingQuantity": 0,
"internalTransferQuantity": 0
}
],
"fulfillableQuantityByLot": [
{
"lotNumber": "1234",
"expirationDate": "2019-08-24T14:15:22Z",
"fulfillableQuantity": 0,
"onHandQuantity": 0,
"committedQuantity": 0,
"awaitingQuantity": 0,
"internalTransferQuantity": 0,
"fulfillableQuantityByFulfillmentCenter": [
{
"fulfillmentCenterId": 0,
"name": "Cicero",
"fulfillableQuantity": 0,
"onHandQuantity": 0,
"committedQuantity": 0,
"awaitingQuantity": 0,
"internalTransferQuantity": 0
}
]
}
],
"packagingAttribute": "None"
}
]
}
Get All Shipments for Order
Retrieve all Shipments on an Order by Order ID | key: getAllShipmentsForOrder
Get Inventory Item
Get single inventory item by Inventory ID | key: getInventoryItem
Output Example Payload
{
"data": {
"inventoryId": 0,
"name": "Medium Blue T-Shirt",
"isDigital": true,
"isCasePick": true,
"isLot": true,
"dimensions": {
"weight": 0,
"length": 0,
"width": 0,
"depth": 0
},
"totalFulfillableQuantity": 0,
"totalOnHandQuantity": 0,
"totalCommitedQuantity": 0,
"totalSellableQuantity": 0,
"totalAwaitingQuantity": 0,
"totalExceptionQuantity": 0,
"totalInternalTransferQuantity": 0,
"totalBackorderedQuantity": 0,
"isActive": true,
"fulfillableQuantityByFulfillmentCenter": [
{
"fulfillmentCenterId": 0,
"name": "Cicero",
"fulfillableQuantity": 0,
"onHandQuantity": 0,
"committedQuantity": 0,
"awaitingQuantity": 0,
"internalTransferQuantity": 0
}
],
"fulfillableQuantityByLot": [
{
"lotNumber": "1234",
"expirationDate": "2019-08-24T14:15:22Z",
"fulfillableQuantity": 0,
"onHandQuantity": 0,
"committedQuantity": 0,
"awaitingQuantity": 0,
"internalTransferQuantity": 0,
"fulfillableQuantityByFulfillmentCenter": [
{
"fulfillmentCenterId": 0,
"name": "Cicero",
"fulfillableQuantity": 0,
"onHandQuantity": 0,
"committedQuantity": 0,
"awaitingQuantity": 0,
"internalTransferQuantity": 0
}
]
}
],
"packagingAttribute": "None"
}
}
Get Logs for Shipment
Retrieve logs for a Shipment by Shipment ID | key: getLogsShipment
Get Multiple Products
Retrieve a list of several Products | key: listProduct
Output Example Payload
{
"data": [
{
"id": 0,
"reference_id": "TShirtBlueM",
"bundle_root_information": {},
"created_date": "2019-08-24T14:15:22Z",
"channel": {},
"sku": "TShirtBlueM",
"name": "Medium Blue T-Shirt",
"barcode": "123456789012",
"gtin": "012345678905",
"upc": "012345678912",
"unit_price": 20.32,
"total_fulfillable_quantity": 0,
"total_onhand_quantity": 0,
"total_committed_quantity": 0,
"fulfillable_inventory_items": [],
"fulfillable_quantity_by_fulfillment_center": []
}
]
}
Get Order
Retrieve an order by Order ID | key: getOrder
Get Shipment
Retrieve a Shipment by Shipment ID | key: getShipment
Get Single Product
Retrieve a single product by Product ID | key: getProduct
Output Example Payload
{
"data": {
"id": 0,
"reference_id": "TShirtBlueM",
"bundle_root_information": {
"id": 0,
"name": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"channel": {
"id": 0,
"name": "House of Slippers"
},
"sku": "TShirtBlueM",
"name": "Medium Blue T-Shirt",
"barcode": "123456789012",
"gtin": "012345678905",
"upc": "012345678912",
"unit_price": 20.32,
"total_fulfillable_quantity": 0,
"total_onhand_quantity": 0,
"total_committed_quantity": 0,
"fulfillable_inventory_items": [
{}
],
"fulfillable_quantity_by_fulfillment_center": [
{}
]
}
}
Get Warehouse Receiving Order Box Labels
Retrieves Receiving Order Box Labels by Order ID | key: getWarehouseReceivingOrderBoxLabels
Get Warehouse Receiving Orders
Receive a Warehouse Receiving Order by ID | key: getWarehouseReceivingOrders
List Channels
List user-authorized channels info | key: listChannels
List Fulfillment Centers
Retrieves a list of Fulfillment Centers | key: listFulfillmentCenters
List Inventory Items
Retrieve a list of Inventory Items | key: listInventoryItems
Output Example Payload
{
"data": [
{
"inventoryId": 0,
"name": "Medium Blue T-Shirt",
"isDigital": true,
"isCasePick": true,
"isLot": true,
"dimensions": {
"weight": 0,
"length": 0,
"width": 0,
"depth": 0
},
"totalFulfillableQuantity": 0,
"totalOnHandQuantity": 0,
"totalCommitedQuantity": 0,
"totalSellableQuantity": 0,
"totalAwaitingQuantity": 0,
"totalExceptionQuantity": 0,
"totalInternalTransferQuantity": 0,
"totalBackorderedQuantity": 0,
"isActive": true,
"fulfillableQuantityByFulfillmentCenter": [
{
"fulfillmentCenterId": 0,
"name": "Cicero",
"fulfillableQuantity": 0,
"onHandQuantity": 0,
"committedQuantity": 0,
"awaitingQuantity": 0,
"internalTransferQuantity": 0
}
],
"fulfillableQuantityByLot": [
{
"lotNumber": "1234",
"expirationDate": "2019-08-24T14:15:22Z",
"fulfillableQuantity": 0,
"onHandQuantity": 0,
"committedQuantity": 0,
"awaitingQuantity": 0,
"internalTransferQuantity": 0,
"fulfillableQuantityByFulfillmentCenter": [
{
"fulfillmentCenterId": 0,
"name": "Cicero",
"fulfillableQuantity": 0,
"onHandQuantity": 0,
"committedQuantity": 0,
"awaitingQuantity": 0,
"internalTransferQuantity": 0
}
]
}
],
"packagingAttribute": "None"
}
]
}
List Locations
Receives a list of the physical locations across a fulfillment network | key: listLocations
List Orders
Retrieve all Orders | key: listOrders
List Warehouse Receiving Orders
Retrieve all Warehouse Receiving Orders | key: listWarehouseReceivingOrders
List Webhooks
Get a list of active Webhooks | key: listWebhooks
Raw Request
Send raw HTTP request to ShipBob | key: rawRequest
Update Product
Update information on a single Product | key: updateProduct
Output Example Payload
{
"data": {
"id": 0,
"reference_id": "TShirtBlueM",
"bundle_root_information": {
"id": 0,
"name": "string"
},
"created_date": "2019-08-24T14:15:22Z",
"channel": {
"id": 0,
"name": "House of Slippers"
},
"sku": "TShirtBlueM",
"name": "Medium Blue T-Shirt",
"barcode": "123456789012",
"gtin": "012345678905",
"upc": "012345678912",
"unit_price": 20.32,
"total_fulfillable_quantity": 0,
"total_onhand_quantity": 0,
"total_committed_quantity": 0,
"fulfillable_inventory_items": [
{}
],
"fulfillable_quantity_by_fulfillment_center": [
{}
]
}
}