Log inStart free trial

ShipBob Finance API: Watch Events, Create an Order

Global 3PL network offering 2-day delivery, distributed inventory, and a developer API. 1 trigger, 6 searches, and 4 actions including Watch Events.

About this integration

Global 3PL network offering 2-day delivery, distributed inventory, and a developer API. This integration exposes its full API as workflow modules.

The integration includes 1 trigger, 6 search modules and 4 actions. Connections use basic authentication. Webhook-based triggers fire instantly without polling.

How to connect

The credential form asks for Personal Access Token (PAT).

Prefer the interactive builder form? Open it on the app page.

Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.

Field	Type	Help
Personal Access Token (PAT)Required	password	Your PAT can be provided by ShipBob support.

Use it in workflow automation

Start with Watch Events, then add Create an Order.

The canvas below runs Watch Events into Create an Order — watch the video, then drop a node onto the canvas.

Select the Watch Events trigger and the workflow fires automatically when the event occurs — no polling required.

Then add Create an Order as the next node. Branch, filter, or hand off to other integrations from there.

The integration includes 5 ready-made modules for finance work — each run logs its inputs and outputs for debugging.

ShipBob workflow on the canvas: Watch Events then Create an Order

ShipBob workflow on the canvas: Watch Events then Create an Order

Triggers, searches and actions

Browse every ShipBob module field below: 1 trigger, 6 searchs, and 4 actions you can drop onto the canvas.

Triggers

This integration includes 1 trigger — start a workflow the moment something changes in the app.

Watch Events

Searches

Use any of 6 search modules to retrieve records without leaving the workflow canvas.

Get an Order
Get a Product
List Order Shipments
Search Inventory Items
Search Orders

1more search

Actions

This integration includes 4 action modules — create, update, or delete records as part of any workflow.

Create an Order
Create a Product
Make an API Call
Update a Product

Explore the fields available for each ShipBob trigger, search, and action.

Triggers

Output fields

Field	Type
User ID	number
Email address	email
Name	text
Date created	date

Searches

Input fields

Field	Type
Channel IdRequired	number
Order IDRequired	number

Output fields

Field	Type
ID	number
Created Date	date
Purchase Date	date
Reference ID	text
Order Number	text
Status	text
Type	text
Channel	object
ID	number
Name	text
Shipping Method	text
Recipient	object
Name	text
Address	object
Email	text
Phone Number	text
Products	array
Tags	array
Shipments	array
Gift Message	text
Shipping Terms	object
Carrier Type	text
Payment Term	text
Retailer Program Data	object
Purchase Order Number	text
Retailer Program Type	text
Mark For Store	text
Department	text
Delivery Date	text
Addresses	array
Customer Ticket Number	text
Ship by Date	text
Do Not Ship Before Date	text
Financials	object
Total Price	number

Input fields

Field	Type
Channel IdRequired	number
Product IDRequired	number

Output fields

Field	Type
ID	number
Reference ID	text
Bundle Root Information	object
ID	number
Name	text
Created Date	date
Channel	object
ID	number
Name	text
SKU	text
Name	text
Barcode	text
GTIN	text
UPC	text
Unit Price	number
Total Fulfillable Quantity	number
Total Onhand Quantity	number
Total Committed Quantity	number
Fulfillable Inventory Items	array
Fulfillable Quantity by Fulfillment Center	array

Input fields

Field	Type
Channel IdRequired	number
Limit	number

Output fields

Field	Type
ID	number
Order ID	number
Reference ID	text
Recipient	object
Name	text
Full Name	text
Address	object
Email	text
Phone Number	text
Created Date	text
Last Update at	date
Last Tracking Update at	date
Status	text
Status Details	array
Location	object
ID	number
Name	text
Invoice Amount	number
Invoice Currency Code	text
Insurance Value	number
Ship Option	text
Package Material Type	text
Tracking	object
Carrier	text
Tracking Number	text
Carrier Service	text
Tracking URL	url
Bol	text
Shipping Date	text
Pro Number	text
Scac	text
Products	array
Parent Cartons	array
Measurements	object
Total Weight Oz	number
Length In	number
Width In	number
Depth In	number
Require Signature	boolean

6other output fields

Input fields

Field	Type
Is Active	boolean
Is Digital	boolean
Inventory IDs	array
Sort	text
Search	text
Location Type	text
Limit	number

Output fields

Field	Type
ID	number
Name	text
Is Digital	boolean
Is Case Pick	boolean
Is Lot	boolean
Dimensions	object
Weight	number
Length	number
Width	number
Depth	number
Total Fulfillable Quantity	number
Total Onhand Quantity	number
Total Committed Quantity	number
Total Sellable Quantity	number
Total Awaiting Quantity	number
Total Exception Quantity	number
Total Internal Transfer Quantity	number
Total Backordered Quantity	number
Is Active	boolean
Fulfillable Quantity By Fulfillment Center	array
Fulfillable Quantity By Lot	array
Packaging Attribute	text

Input fields

Field	Type
IDs	array
Reference IDs	array
Start Date	date
End Date	date
Sort Order	choice
Has Tracking	boolean
Last Update Start Date	date
Last Update End Date	date
Is Tracking Uploaded	boolean
Last Tracking Update Start Date	date
Last Tracking Update End Date	date
Limit	number

Output fields

Field	Type
ID	number
Created Date	date
Purchase Date	date
Reference ID	text
Order Number	text
Status	text
Type	text
Channel	object
ID	number
Name	text
Shipping Method	text
Recipient	object
Name	text
Address	object
Email	text
Phone Number	text
Products	array
Tags	array
Shipments	array
Gift Message	text
Shipping Terms	object
Carrier Type	text
Payment Term	text
Retailer Program Data	object
Purchase Order Number	text
Retailer Program Type	text
Mark For Store	text
Department	text
Delivery Date	text
Addresses	array
Customer Ticket Number	text
Ship by Date	text
Do Not Ship Before Date	text
Financials	object
Total Price	number

Input fields

Field	Type
Reference IDs	array
Product IDs	array
Search	text
Active Status	choice
Bundle Status	choice
Limit	number

Output fields

Field	Type
ID	number
Reference ID	text
Bundle Root Information	object
ID	number
Name	text
Created Date	date
Channel	object
ID	number
Name	text
SKU	text
Name	text
Barcode	text
GTIN	text
UPC	text
Unit Price	number
Total Fulfillable Quantity	number
Total Onhand Quantity	number
Total Committed Quantity	number
Fulfillable Inventory Items	array
Fulfillable Quantity by Fulfillment Center	array

Actions

Input fields

Field	Type
Channel IdRequired	number
Reference IDRequired	text
Shipping Method	text
Recipient InformationRequired	object
NameRequired	text
AddressRequired	object
ProductsRequired	array
Order Number	text
Order Type	choice
Tags	array
Purchase Date	date
Location ID	number
Shipping Terms	object
Carrier Type	choice
Payment Term	choice
Retailer Program Data	object
Purchase Order Number	text
Retailer Program Type	text
Mark For Store	text
Department	text
Delivery Date	date
Addresses	array
Customer Ticket Number	text
Ship By Date	date
Do Not Ship Before Date	date
Financials	object
Total Price	number
Gift Message	text

Output fields

Field	Type
ID	number
Created Date	date
Purchase Date	date
Reference ID	text
Order Number	text
Status	text
Type	text
Channel	object
ID	number
Name	text
Shipping Method	text
Recipient	object
Name	text
Address	object
Email	email
Phone Number	text
Products	array
Tags	array
Shipments	array
Gift Message	text
Shipping Terms	object
Carrier Type	text
Payment Term	text
Retailer Program Data	object
Purchase Order Number	text
Retailer Program Type	text
Mark For Store	text
Department	text
Delivery Date	text
Addresses	array
Customer Ticket Number	text
Ship by Date	text
Do Not Ship Before Date	text
Financials	object
Total Price	number

Input fields

Field	Type
Channel IdRequired	number
Reference IDRequired	text
Product NameRequired	text
SKU	text
Barcode	text
GTIN	text
UPC	text
Unit Price	number

Output fields

Field	Type
ID	number
Reference ID	text
Bundle Root Information	object
ID	number
Name	text
Created Date	date
Channel	object
ID	number
Name	text
SKU	text
Name	text
Barcode	text
GTIN	text
UPC	text
Unit Price	number
Total Fulfillable Quantity	number
Total Onhand Quantity	number
Total Committed Quantity	number
Fulfillable Inventory Items	array
Fulfillable Quantity by Fulfillment Center	array

Input fields

Field	Type
URLRequired	text
MethodRequired	choice
Headers	array
Header	object
Query String	array
Parameter	object
Body	text

Output fields

Field	Type
Body	text
Headers	object
Status code	number

Input fields

Field	Type
Channel IdRequired	number
Product IDRequired	number
Reference ID	text
Product Name	text
SKU	text
Barcode	text
GTIN	text
UPC	text
Unit Price	number

Output fields

Field	Type
ID	number
Reference ID	text
Bundle Root Information	object
ID	number
Name	text
Created Date	date
Channel	object
ID	number
Name	text
SKU	text
Name	text
Barcode	text
GTIN	text
UPC	text
Unit Price	number
Total Fulfillable Quantity	number
Total Onhand Quantity	number
Total Committed Quantity	number
Fulfillable Inventory Items	array
Fulfillable Quantity by Fulfillment Center	array