To get started, visit our API Documentation. This comprehensive resource provides step-by-step instructions and helpful tips to ensure a smooth and efficient integration process.
Basic Overview
Our API documentation is organized into 12 main sections, each with detailed subsections. Below is an overview with links to each section:
- Test
- Rates
- Shipments
- Batch and Manifests
- Pickups
- Order Stores
- Services
- Status
- Reports
- Webhook Subscriptions
- Payment Methods
- Customers
The Shipments and Rates sections are the most commonly used. They guide you through obtaining package rates and creating shipping labels.
Best Practices for Using the API
Code Examples
Each API endpoint includes sample code snippets to help you implement requests quickly:
- Located on the right-hand side of the page in a dark gray box.
- Top section – Displays the method, request path, and sample parameters.
- Bottom section – Shows a sample API response.
Understanding Parameters
- The Body Parameters and Response sections in the middle of the page provide detailed breakdowns of each field.
- Click + Show child attributes to see additional details, including Enum values.
Testing in API Explorer
- Use the Try In API Explorer tool to test API requests in real time.
- Enter your API key in the Token section.
- Modify request parameters using the blue toggle under Body, then click Run to see live data.
- Note: Refreshing the page resets the token and parameters.
Using AI Assistance
- Click the search bar and select Ask AI for guidance.
- Ask specific questions to receive AI-generated answers, especially if you’re unsure where to start.
Need Help?
Our documentation is designed to make integration seamless. If you have any questions, contact support@ehub.com—we’re happy to assist.