Skip to main content

ā€‹
Welcome to the Upwell API

The Upwell REST API provides programmatic access to all core functionality of the Upwell platform, including accounts payable automation, accounts receivable management, and document processing for logistics and freight companies. Base URL: https://api.upwell.com
Current Version: 2.33.2
API Prefix: /api/rest/

ā€‹
Core API Modules

Carrier Management

Manage carrier information, invoices, and payment processing

Customer Management

Handle customer profiles, payments, and billing operations

Vendor Management

Manage vendor relationships, contracts, and payment terms

Shipment Tracking

Track shipments, documents, and logistics data

Document Management

Upload, process, and manage invoice and shipment documents

Bill Payments

Process bill payments and manage payment line items

ā€‹
API Features

  • RESTful Design: Standard HTTP methods (GET, POST, PUT, DELETE)
  • JSON Format: All requests and responses use JSON
  • Authentication: API key-based authentication
  • Error Handling: Comprehensive error codes and messages
  • Rate Limiting: Built-in rate limiting for API stability
  • Bulk Operations: Efficient bulk processing for large datasets

ā€‹
Authentication

All API requests must include your API key in the Authorization header. See the Authentication Guide for detailed instructions on obtaining and using your API key. 
curl -X GET "https://api.upwell.com/api/rest/invoices" \
  -H "Authorization: YOUR_API_KEY"

ā€‹
Response Format

All API responses follow a consistent format: 
{
  "data": {},
  "status": "success",
  "message": "Request completed successfully"
}

ā€‹
Getting Started

  1. Obtain your API key
  2. Review the endpoint documentation in the API Reference section
  3. Test your integration using the provided examples
  4. Implement error handling using our troubleshooting guide
For additional support, contact our technical support team.