About this integration
Third-party logistics for ecommerce orders, receivings, and returns. This integration exposes its full API as workflow modules.
The integration includes 4 triggers, 7 search modules and 8 actions. Connections use basic authentication.
How to connect
The credential form asks for API Key, Store ID, and Environment.
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 |
|---|---|---|
API KeyRequired | password | Email at [email protected] to request API Key access from ShipMonk. Once your API store is created, you can generate keys under Account Settings > Stores > Integration API Keys. There, you can also obtain your Store ID. |
Store IDRequired | text | Email at [email protected] to request API Key access from ShipMonk. Once your API store is created, you can generate keys under Account Settings > Stores > Integration API Keys. There, you can also obtain your |
EnvironmentRequired | select | — |
Use it in workflow automation
Start with Watch Orders, then add Complete an Order.
The canvas below runs Watch Orders into Complete an Order — watch the video, then drop a node onto the canvas.
Select the Watch Orders trigger and the workflow fires automatically when the event occurs — no polling required.
Then add Complete an Order as the next node. Branch, filter, or hand off to other integrations from there.
The integration includes 12 ready-made modules for finance work — each run logs its inputs and outputs for debugging.
ShipMonk workflow on the canvas: Watch Orders then Complete an Order
Triggers, searches and actions
Browse every ShipMonk module field below: 4 triggers, 7 searchs, and 8 actions you can drop onto the canvas.
Triggers
This integration includes 4 triggers — start a workflow the moment something changes in the app.
- Watch Orders
- Watch Products
- Watch Receivings
- Watch Returns
Searches
Use any of 7 search modules to retrieve records without leaving the workflow canvas.
- Get an Order
- Get Receiving
- List Warehouses
- Search Orders
- Search Products
Actions
This integration includes 8 action modules — create, update, or delete records as part of any workflow.
- Complete an Order
- Complete a Receiving
- Create or Update an Order
- Create or Update a Product
- Create or Update a Return
Explore the fields available for each ShipMonk trigger, search, and action.
Triggers
| Field | Type |
|---|---|
Order key | text |
Order number | text |
Store | object |
ID | number |
Name | text |
Ordered at | date |
Customer email | |
Ship from | object |
Name | text |
Company | text |
Street 1 | text |
Street 2 | text |
State | text |
City | text |
Zip | text |
Country code | text |
Phone | text |
Email | |
Ship to | object |
Name | text |
Company | text |
Street 1 | text |
Street 2 | text |
State | text |
City | text |
Zip | text |
Country code | text |
Phone | text |
Email | |
Order status | text |
Processing status | text |
Currency code | text |
Items | array |
Actions required | object |
Item mapping | boolean |
Address | boolean |
Shipping mapping | boolean |
Customs | boolean |
At risk | boolean |
Routing | boolean |
Freight quote | boolean |
Freight info | boolean |
Ship short | boolean |
Hs code | boolean |
Packages | array |
Tracking URL | url |
Requested shipping service | text |
Shipping method | object |
ID | number |
Name | text |
Carrier | object |
Master tracking number | text |
Shipment data | object |
Carrier | text |
Service | text |
Carrier tracking URL | url |
Carrier alpha code | text |
Carrier trans method code | text |
Bill of lading number | text |
Master bill of lading number | text |
Load number | text |
Authorization number | text |
Estimated shipping cost | number |
Shipped at | date |
Order size | text |
| Field | Type |
|---|---|
ID | number |
SKU | text |
Name | text |
Created at | date |
Updated at | date |
Is active | boolean |
Product type | text |
Replacement cost | number |
Replacement cost currency | text |
Inventory | object |
Quantity total final | number |
Quantity total available | number |
Quantity total on hand | number |
Quantity total quarantined | number |
Quantity total unavailable | number |
Locations | array |
Hs code | text |
Hs codes | array |
Barcodes | array |
Country code | text |
Stock out days | number |
Custom data | array |
Weight | object |
Value | number |
Unit | text |
Dimensions | object |
Length | number |
Width | number |
Height | number |
Unit | text |
Product bundles | array |
Product handling units | array |
| Field | Type |
|---|---|
ID | number |
Warehouse | text |
Receiving key | text |
Asn | text |
Bol number | text |
Supplier name | text |
Handling unit type | text |
Handling unit quantity | number |
Estimated delivery | text |
Description | text |
Status | text |
Created at | date |
Updated at | date |
Arrived at | date |
Received at | date |
Items | array |
Receiving lines | array |
Custom data | array |
| Field | Type |
|---|---|
ID | number |
Warehouse | text |
Order key | text |
Store ID | number |
Rma | text |
Tracking number | text |
Status | text |
Return reason | text |
Note | text |
Created at | date |
Updated at | date |
Received at | date |
Items | array |
Custom data | array |
Source | text |
Searches
| Field | Type |
|---|---|
Order Key | choice |
Order Number | text |
Store ID | number |
| Field | Type |
|---|---|
Order key | text |
Order number | text |
Store | object |
ID | number |
Name | text |
Ordered at | date |
Customer email | |
Ship from | object |
Name | text |
Company | text |
Street 1 | text |
Street 2 | text |
State | text |
City | text |
Zip | text |
Country code | text |
Phone | text |
Email | |
Ship to | object |
Name | text |
Company | text |
Street 1 | text |
Street 2 | text |
State | text |
City | text |
Zip | text |
Country code | text |
Phone | text |
Email | |
Order status | text |
Processing status | text |
Currency code | text |
Items | array |
Actions required | object |
Item mapping | boolean |
Address | boolean |
Shipping mapping | boolean |
Customs | boolean |
At risk | boolean |
Routing | boolean |
Freight quote | boolean |
Freight info | boolean |
Ship short | boolean |
Hs code | boolean |
Packages | array |
Tracking URL | url |
Requested shipping service | text |
Shipping method | object |
ID | number |
Name | text |
Carrier | object |
Master tracking number | text |
Shipment data | object |
Carrier | text |
Service | text |
Carrier tracking URL | url |
Carrier alpha code | text |
Carrier trans method code | text |
Bill of lading number | text |
Master bill of lading number | text |
Load number | text |
Authorization number | text |
Estimated shipping cost | number |
Shipped at | date |
Order size | text |
| Field | Type |
|---|---|
Receiving Key | choice |
ASN | text |
| Field | Type |
|---|---|
ID | number |
Warehouse | text |
Receiving key | text |
Asn | text |
Bol number | text |
Supplier name | text |
Handling unit type | text |
Handling unit quantity | number |
Estimated delivery | text |
Description | text |
Status | text |
Created at | date |
Updated at | date |
Arrived at | date |
Received at | date |
Items | array |
Receiving lines | array |
Custom data | array |
| Field | Type |
|---|---|
Sort By | choice |
Sort Order | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Identifier | text |
Name | text |
Timezone | text |
Warehouse wms type | text |
Enabled | boolean |
Address | object |
Name | text |
Company | text |
Street 1 | text |
Street 2 | text |
Street 3 | text |
City | text |
State | text |
Postal code | text |
Phone | text |
Residential | boolean |
| Field | Type |
|---|---|
Order Status | choice |
Order Keys | array |
Order Key | text |
Order Numbers | array |
Order Number | text |
Sort Order | choice |
Limit | number |
| Field | Type |
|---|---|
Order key | text |
Order number | text |
Store | object |
ID | number |
Name | text |
Ordered at | date |
Customer email | |
Ship from | object |
Name | text |
Company | text |
Street 1 | text |
Street 2 | text |
State | text |
City | text |
Zip | text |
Country code | text |
Phone | text |
Email | |
Ship to | object |
Name | text |
Company | text |
Street 1 | text |
Street 2 | text |
State | text |
City | text |
Zip | text |
Country code | text |
Phone | text |
Email | |
Order status | text |
Processing status | text |
Currency code | text |
Items | array |
Actions required | object |
Item mapping | boolean |
Address | boolean |
Shipping mapping | boolean |
Customs | boolean |
At risk | boolean |
Routing | boolean |
Freight quote | boolean |
Freight info | boolean |
Ship short | boolean |
Hs code | boolean |
Packages | array |
Tracking URL | url |
Requested shipping service | text |
Shipping method | object |
ID | number |
Name | text |
Carrier | object |
Master tracking number | text |
Shipment data | object |
Carrier | text |
Service | text |
Carrier tracking URL | url |
Carrier alpha code | text |
Carrier trans method code | text |
Bill of lading number | text |
Master bill of lading number | text |
Load number | text |
Authorization number | text |
Estimated shipping cost | number |
Shipped at | date |
Order size | text |
| Field | Type |
|---|---|
Status | choice |
Search | text |
Sort By | choice |
Sort Order | choice |
Date Updated Start | date |
Date Updated End | date |
Date Created Start | date |
Date Created End | date |
Limit | number |
| Field | Type |
|---|---|
ID | number |
SKU | text |
Name | text |
Created at | date |
Updated at | date |
Is active | boolean |
Product type | text |
Replacement cost | number |
Replacement cost currency | text |
Inventory | object |
Quantity total final | number |
Quantity total available | number |
Quantity total on hand | number |
Quantity total quarantined | number |
Quantity total unavailable | number |
Locations | array |
Hs code | text |
Hs codes | array |
Barcodes | array |
Country code | text |
Stock out days | number |
Custom data | array |
Weight | object |
Value | number |
Unit | text |
Dimensions | object |
Length | number |
Width | number |
Height | number |
Unit | text |
Product bundles | array |
Product handling units | array |
| Field | Type |
|---|---|
ASN | text |
Warehouse ID | text |
Created At | date |
Updated At | date |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Warehouse | text |
Receiving key | text |
Asn | text |
Bol number | text |
Supplier name | text |
Handling unit type | text |
Handling unit quantity | number |
Estimated delivery | text |
Description | text |
Status | text |
Created at | date |
Updated at | date |
Arrived at | date |
Received at | date |
Items | array |
Receiving lines | array |
Custom data | array |
| Field | Type |
|---|---|
RMA | text |
Return Status | choice |
Warehouse ID | number |
Return Reason | choice |
Created At | date |
Updated At | date |
Desired Action | choice |
Limit | number |
| Field | Type |
|---|---|
ID | number |
Warehouse | text |
Order key | text |
Store ID | number |
Rma | text |
Tracking number | text |
Status | text |
Return reason | text |
Note | text |
Created at | date |
Updated at | date |
Received at | date |
Items | array |
Custom data | array |
Source | text |
Actions
| Field | Type |
|---|---|
Order KeyRequired | choice |
Store IDRequired | number |
Pack TypeRequired | choice |
| Field | Type |
|---|---|
Status | number |
| Field | Type |
|---|---|
Completion ModeRequired | choice |
Receiving Key | text |
ASN | text |
| Field | Type |
|---|---|
Status | number |
| Field | Type |
|---|---|
Store IDRequired | number |
ItemsRequired | array |
Attributes | array |
Ship ToRequired | object |
Name | text |
Company | text |
Street 1 | text |
Street 2 | text |
State | text |
City | text |
ZIP | text |
Country Code | text |
Phone | text |
Order NumberRequired | text |
Requested Shipping ServiceRequired | text |
Trading Partner | text |
Order Type | choice |
Order KeyRequired | text |
Ordered AtRequired | date |
Customer Email | |
Shipping Paid | number |
Taxes Paid | number |
Order StatusRequired | choice |
Currency Code | text |
References | array |
Customer Notes | text |
Internal Notes | text |
Warehouse | text |
Gift Message | text |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
Required PackagingRequired | choice |
Currency CodeRequired | text |
Product KeyRequired | text |
SKURequired | text |
NameRequired | text |
FragileRequired | boolean |
Replacement CostRequired | number |
Customs Declaration ValueRequired | number |
Country of OriginRequired | text |
Weight (Lb) | number |
HS Code | text |
Image URL | url |
Dimensions (Inches) | object |
Width | number |
Height | number |
Length | number |
Custom Data | array |
| Field | Type |
|---|---|
Status | number |
Data | object |
Message | text |
| Field | Type |
|---|---|
WarehouseRequired | text |
RMARequired | text |
Store IDRequired | number |
Return ReasonRequired | choice |
Order Key | text |
Note | text |
Tracking Number | text |
ItemsRequired | array |
Custom Data | array |
| Field | Type |
|---|---|
Status | number |
Data | object |
Message | text |
ID | number |
| Field | Type |
|---|---|
WarehouseRequired | text |
ASNRequired | text |
Supplier NameRequired | text |
Handling Unit TypeRequired | choice |
Handling Unit QuantityRequired | number |
Estimated DeliveryRequired | date |
Receiving Key | text |
BOL Number | text |
Description | text |
Category | choice |
Items | array |
Custom Data | array |
| Field | Type |
|---|---|
Message | text |
| Field | Type |
|---|---|
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
| Field | Type |
|---|---|
Body | text |
Headers | object |
Status code | number |
| Field | Type |
|---|---|
Order KeyRequired | choice |
Store IDRequired | number |
Submit AtRequired | date |
| Field | Type |
|---|---|
Status | number |

