Skip to main content

​
Getting Started with Upwell

Follow these steps to set up your Upwell account and start processing carrier invoices.

​
Initial Setup

Use the email address provided by your account manager to access your Upwell account. If you haven’t received your login credentials, please contact your account manager.
Navigate to the Integrations page to set up your Transportation Management System (TMS) integration:
  1. Click on “Integrations” in the main navigation
  2. Select your TMS provider
  3. Follow the provider-specific configuration steps
  4. Test the connection to ensure proper data flow
Configure your shipper portal connections to enable automated rate validation:
  1. Go to the Shipper Portal section
  2. Add your carrier credentials
  3. Verify the connection for each carrier

​
Final Configuration

Set up your email configuration to receive carrier invoices:
  1. Navigate to Email Settings
  2. Configure your dedicated invoice processing email address
  3. Set up any required email filters or rules
Begin sending carrier invoices to your configured email address. The system will automatically:
  • Receive and process incoming invoices
  • Match invoices against shipment data
  • Validate rates and accessorials
  • Flag any discrepancies for review

​
For Developers

If you’re building a TMS integration or working with the Upwell API directly, start here instead:
1

Get your API key

Create one in the Upwell dashboard under Account → API keys — it authenticates every request via the Authorization header (with or without a Bearer prefix, both work). See Authentication.

Account then API keys. Add API Key issues a key; the value is shown once, at creation.

2

Learn the data model

Understand the core objects (shipments, invoices, , , payments) and how they relate. See Core concepts & data model.
3

Sync your foundation data

Push customers, carriers, shipments, and bills from your TMS. See Syncing foundation entities.
4

Build your AP or AR flow

Choose your starting point: Carrier invoice submission (AP), Customer invoices (AR), or Purchase orders & vendor invoices.
5

Subscribe to webhooks

Get notified when invoices are processed, approved, or hit exceptions. See Outbound webhooks.
Read Integration patterns for cross-cutting conventions: integer-cents money, the sourceSystem / sourceSystemId upsert key, the input wrapper, and the presigned-upload flow.

​
Need Help?

Contact Support

Get help from our support team.

API Reference

Browse our detailed API documentation.

Troubleshooting

Find solutions to common issues.

Authentication Guide

Learn how to authenticate with the API.