ShipMonk icon

ShipMonk

Third-party logistics for ecommerce orders, receivings, and returns.

4 triggers7 searches8 actionsPollingAuth: API key

AI-assisted documentation13 min read

This documentation is compiled from our integration source code, internal specs for ShipMonk, its official API documentation and anonymized requests logs we collect from our support team[2].

Open ShipMonk on WEXTL →

Before you set up the credential, make sure you have an active ShipMonk account and an API access token from your account settings ready.[3]

  • API KeypasswordRequired

    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.

    [1]
  • Store IDtextRequired

    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.

    [1]
  • EnvironmentselectRequired
  1. Log in to your WEXTL account, add the ShipMonk node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your ShipMonk account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes

Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →

Watch OrdersTrigger
Output fields[3]
FieldType
Order keytext
Order numbertext
Storeobject
IDnumber
Nametext
Ordered atdate
Customer emailemail
Ship fromobject
Nametext
Companytext
Street 1text
Street 2text
Statetext
Citytext
Ziptext
Country codetext
Phonetext
Emailemail
Ship toobject
Nametext
Companytext
Street 1text
Street 2text
Statetext
Citytext
Ziptext
Country codetext
Phonetext
Emailemail
Order statustext
Processing statustext
Currency codetext
Itemsarray
Actions requiredobject
Item mappingboolean
Addressboolean
Shipping mappingboolean
Customsboolean
At riskboolean
Routingboolean
Freight quoteboolean
Freight infoboolean
Ship shortboolean
Hs codeboolean
Packagesarray
Tracking URLurl
Requested shipping servicetext
Shipping methodobject
IDnumber
Nametext
Carrierobject
Master tracking numbertext
Shipment dataobject
Carriertext
Servicetext
Carrier tracking URLurl
Carrier alpha codetext
Carrier trans method codetext
Bill of lading numbertext
Master bill of lading numbertext
Load numbertext
Authorization numbertext
Estimated shipping costnumber
Shipped atdate
Order sizetext
5other output fields
Watch ProductsTrigger
Output fields[3]
FieldType
IDnumber
SKUtext
Nametext
Created atdate
Updated atdate
Is activeboolean
Product typetext
Replacement costnumber
Replacement cost currencytext
Inventoryobject
Quantity total finalnumber
Quantity total availablenumber
Quantity total on handnumber
Quantity total quarantinednumber
Quantity total unavailablenumber
Locationsarray
Hs codetext
Hs codesarray
Barcodesarray
Country codetext
Stock out daysnumber
Custom dataarray
Weightobject
Valuenumber
Unittext
Dimensionsobject
Lengthnumber
Widthnumber
Heightnumber
Unittext
Product bundlesarray
Product handling unitsarray
Watch ReceivingsTrigger
Output fields[3]
FieldType
IDnumber
Warehousetext
Receiving keytext
Asntext
Bol numbertext
Supplier nametext
Handling unit typetext
Handling unit quantitynumber
Estimated deliverytext
Descriptiontext
Statustext
Created atdate
Updated atdate
Arrived atdate
Received atdate
Itemsarray
Receiving linesarray
Custom dataarray
Watch ReturnsTrigger
Output fields[3]
FieldType
IDnumber
Warehousetext
Order keytext
Store IDnumber
Rmatext
Tracking numbertext
Statustext
Return reasontext
Notetext
Created atdate
Updated atdate
Received atdate
Itemsarray
Custom dataarray
Sourcetext
Get an OrderAction
Input fields[3]
FieldType
Order Keychoice
Order Numbertext
Store IDnumber
Output fields[3]
FieldType
Order keytext
Order numbertext
Storeobject
IDnumber
Nametext
Ordered atdate
Customer emailemail
Ship fromobject
Nametext
Companytext
Street 1text
Street 2text
Statetext
Citytext
Ziptext
Country codetext
Phonetext
Emailemail
Ship toobject
Nametext
Companytext
Street 1text
Street 2text
Statetext
Citytext
Ziptext
Country codetext
Phonetext
Emailemail
Order statustext
Processing statustext
Currency codetext
Itemsarray
Actions requiredobject
Item mappingboolean
Addressboolean
Shipping mappingboolean
Customsboolean
At riskboolean
Routingboolean
Freight quoteboolean
Freight infoboolean
Ship shortboolean
Hs codeboolean
Packagesarray
Tracking URLurl
Requested shipping servicetext
Shipping methodobject
IDnumber
Nametext
Carrierobject
Master tracking numbertext
Shipment dataobject
Carriertext
Servicetext
Carrier tracking URLurl
Carrier alpha codetext
Carrier trans method codetext
Bill of lading numbertext
Master bill of lading numbertext
Load numbertext
Authorization numbertext
Estimated shipping costnumber
Shipped atdate
Order sizetext
5other output fields
Get ReceivingAction
Input fields[3]
FieldType
Receiving Keychoice
ASNtext
Output fields[3]
FieldType
IDnumber
Warehousetext
Receiving keytext
Asntext
Bol numbertext
Supplier nametext
Handling unit typetext
Handling unit quantitynumber
Estimated deliverytext
Descriptiontext
Statustext
Created atdate
Updated atdate
Arrived atdate
Received atdate
Itemsarray
Receiving linesarray
Custom dataarray
List WarehousesSearch
Input fields[3]
FieldType
Sort Bychoice
Sort Orderchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Identifiertext
Nametext
Timezonetext
Warehouse wms typetext
Enabledboolean
Addressobject
Nametext
Companytext
Street 1text
Street 2text
Street 3text
Citytext
Statetext
Postal codetext
Phonetext
Residentialboolean
Search OrdersSearch
Input fields[3]
FieldType
Order Statuschoice
Order Keysarray
Order Keytext
Order Numbersarray
Order Numbertext
Sort Orderchoice
Limitnumber
Output fields[3]
FieldType
Order keytext
Order numbertext
Storeobject
IDnumber
Nametext
Ordered atdate
Customer emailemail
Ship fromobject
Nametext
Companytext
Street 1text
Street 2text
Statetext
Citytext
Ziptext
Country codetext
Phonetext
Emailemail
Ship toobject
Nametext
Companytext
Street 1text
Street 2text
Statetext
Citytext
Ziptext
Country codetext
Phonetext
Emailemail
Order statustext
Processing statustext
Currency codetext
Itemsarray
Actions requiredobject
Item mappingboolean
Addressboolean
Shipping mappingboolean
Customsboolean
At riskboolean
Routingboolean
Freight quoteboolean
Freight infoboolean
Ship shortboolean
Hs codeboolean
Packagesarray
Tracking URLurl
Requested shipping servicetext
Shipping methodobject
IDnumber
Nametext
Carrierobject
Master tracking numbertext
Shipment dataobject
Carriertext
Servicetext
Carrier tracking URLurl
Carrier alpha codetext
Carrier trans method codetext
Bill of lading numbertext
Master bill of lading numbertext
Load numbertext
Authorization numbertext
Estimated shipping costnumber
Shipped atdate
Order sizetext
5other output fields
Search ProductsSearch
Input fields[3]
FieldType
Statuschoice
Searchtext
Sort Bychoice
Sort Orderchoice
Date Updated Startdate
Date Updated Enddate
Date Created Startdate
Date Created Enddate
Limitnumber
Output fields[3]
FieldType
IDnumber
SKUtext
Nametext
Created atdate
Updated atdate
Is activeboolean
Product typetext
Replacement costnumber
Replacement cost currencytext
Inventoryobject
Quantity total finalnumber
Quantity total availablenumber
Quantity total on handnumber
Quantity total quarantinednumber
Quantity total unavailablenumber
Locationsarray
Hs codetext
Hs codesarray
Barcodesarray
Country codetext
Stock out daysnumber
Custom dataarray
Weightobject
Valuenumber
Unittext
Dimensionsobject
Lengthnumber
Widthnumber
Heightnumber
Unittext
Product bundlesarray
Product handling unitsarray
Search ReceivingsSearch
Input fields[3]
FieldType
ASNtext
Warehouse IDtext
Created Atdate
Updated Atdate
Limitnumber
Output fields[3]
FieldType
IDnumber
Warehousetext
Receiving keytext
Asntext
Bol numbertext
Supplier nametext
Handling unit typetext
Handling unit quantitynumber
Estimated deliverytext
Descriptiontext
Statustext
Created atdate
Updated atdate
Arrived atdate
Received atdate
Itemsarray
Receiving linesarray
Custom dataarray
Search ReturnsSearch
Input fields[3]
FieldType
RMAtext
Return Statuschoice
Warehouse IDnumber
Return Reasonchoice
Created Atdate
Updated Atdate
Desired Actionchoice
Limitnumber
Output fields[3]
FieldType
IDnumber
Warehousetext
Order keytext
Store IDnumber
Rmatext
Tracking numbertext
Statustext
Return reasontext
Notetext
Created atdate
Updated atdate
Received atdate
Itemsarray
Custom dataarray
Sourcetext
Complete a ReceivingAction
Input fields[3]
FieldType
Completion ModeRequired
choice
Receiving Keytext
ASNtext
Output fields[3]
FieldType
Statusnumber
Complete an OrderAction
Input fields[3]
FieldType
Order KeyRequired
choice
Store IDRequired
number
Pack TypeRequired
choice
Output fields[3]
FieldType
Statusnumber
Create or Update a ProductAction
Input fields[3]
FieldType
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 Codetext
Image URLurl
Dimensions (Inches)object
Widthnumber
Heightnumber
Lengthnumber
Custom Dataarray
Output fields[3]
FieldType
Statusnumber
Dataobject
Messagetext
Create or Update a ReturnAction
Input fields[3]
FieldType
WarehouseRequired
text
RMARequired
text
Store IDRequired
number
Return ReasonRequired
choice
Order Keytext
Notetext
Tracking Numbertext
ItemsRequired
array
Custom Dataarray
Output fields[3]
FieldType
Statusnumber
Dataobject
Messagetext
IDnumber
Create or Update an OrderAction
Input fields[3]
FieldType
Store IDRequired
number
ItemsRequired
array
Attributesarray
Ship ToRequired
object
Nametext
Companytext
Street 1text
Street 2text
Statetext
Citytext
ZIPtext
Country Codetext
Phonetext
Order NumberRequired
text
Requested Shipping ServiceRequired
text
Trading Partnertext
Order Typechoice
Order KeyRequired
text
Ordered AtRequired
date
Customer Emailemail
Shipping Paidnumber
Taxes Paidnumber
Order StatusRequired
choice
Currency Codetext
Referencesarray
Customer Notestext
Internal Notestext
Warehousetext
Gift Messagetext
10other input fields
Output fields[3]
FieldType
Messagetext
Create or Update ReceivingAction
Input fields[3]
FieldType
WarehouseRequired
text
ASNRequired
text
Supplier NameRequired
text
Handling Unit TypeRequired
choice
Handling Unit QuantityRequired
number
Estimated DeliveryRequired
date
Receiving Keytext
BOL Numbertext
Descriptiontext
Categorychoice
Itemsarray
Custom Dataarray
Output fields[3]
FieldType
Messagetext
Make an API Calluniversal
Input fields[3]
FieldType
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Status codenumber
Submit an OrderAction
Input fields[3]
FieldType
Order KeyRequired
choice
Store IDRequired
number
Submit AtRequired
date
Output fields[3]
FieldType
Statusnumber

Look for ShipMonk templates in the WEXTL template library.

Browse templates →
  1. WEXTL® ShipMonk Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for ShipMonk.
  4. WEXTL® visual workflow builder data.

Last updated: Jul 24, 2026 18:12