E-commerce stores that ship more than a handful of orders a day hit the same wall: someone manually keying order details into a courier portal, printing waybills one at a time, and messaging customers with tracking numbers by hand. It works at ten orders a week. It falls apart at fifty a day.
Shipping API integration solves this by letting your store’s backend talk directly to the courier’s system, pulling rates, creating shipments, generating labels, and pushing tracking updates automatically. For businesses shipping out of Sri Lanka to local and international customers, it’s usually one of the first backend systems worth automating.
What Is Shipping API Integration, and How Does It Work?
A shipping API lets your website or order-management system send structured requests to a courier’s servers instead of a human filling in a web form. Core operations typically include rate calculation, shipment creation, label generation, tracking, and pickup scheduling, though not every courier’s API covers all five; some are built purely around booking and tracking.
Most couriers expose either a REST API (JSON over HTTPS) or an older SOAP-based web service (XML against a WSDL contract). REST is faster to build against; SOAP integrations take longer and need a proper SOAP client library. Automating this removes manual address-entry errors, lets you compare rates before committing to a courier, and gives customers real tracking instead of guesswork.
Why Sri Lankan Businesses Need This
Around 20–30 orders a day, manual shipping becomes a full-time job and errors climb. Once shipments run through an API, comparing Aramex against DHL against a local courier is one function call instead of three portal logins. Customers, especially international ones in the UK, Middle East, and Australia, expect real-time tracking as standard. COD reconciliation, still central to Sri Lankan e-commerce, becomes far more auditable against API-driven shipment records than manual books. And a business splitting domestic and international volume benefits from one system talking to multiple couriers rather than staff switching dashboards.
Shipping API Options in Sri Lanka
- Domex has a documented REST/JSON API authenticated via an API key. It covers:
– Shipment creation
– Shipment updates
– Shipment deletion
– Waybill lookup
– Status history
Key limitations and considerations:
– No rate-calculation or label-generation endpoint, so it’s booking-and-tracking only.
– Strict field validation, including tight character limits and rejected zero/negative values.
– Storefront data needs sanitizing before it’s sent. - Aramex covers rate calculation, shipment creation, tracking, pickup scheduling, and labels via a SOAP/XML Shipping Services API. Credentials (username, account number, PIN, entity code) come from your Aramex account manager, not self-signup; a sandbox is available before production.
- DHL Express offers the REST-based MyDHL API for rates, shipment creation, tracking, and labels, with existing WooCommerce/Shopify plugins, a strong fit for international-heavy shipping volume.
- FedEx provides developer APIs for similar functions, migrating from SOAP toward REST, check current docs for which version applies before building.
- Pronto Lanka and other domestic couriers mostly lack public developer portals; access is arranged directly with the courier’s business team case-by-case.
- Sri Lanka Post’s EMS tracking is best accessed via third-party tracking aggregators rather than a direct developer API.
- PickMe Fleet supports same-day local delivery in Colombo and other cities, with integration access arranged through their business team rather than open signup.
No courier is universally “best”, match the provider to your actual shipping mix. Most mixed domestic/international stores end up integrating two or three providers and routing by cost, speed, or documentation quality.
How the Build Works
A shipping API integration typically follows these steps:
1. Identify Your Shipping Requirements
Determine which couriers you need and how many orders you process. Decide whether you need:
- Rate calculation
- Shipment creation
- Tracking
- Label generation
- COD handling
- Pickup scheduling
2. Get API Access
Contact the relevant courier and request API credentials, documentation and sandbox access where available.
3. Review the API Documentation
Before development begins, check:
- Authentication requirements
- Available API endpoints
- Request and response formats
- Required fields
- Validation rules
- Rate limits
- Error codes
4. Build and Test the Integration
Start development using the courier’s sandbox or test environment where available. Build each function separately, since different couriers may support different features.
5. Add Error Handling and Logging
The integration should handle API failures, timeouts, invalid data and rejected requests. Log errors for troubleshooting while ensuring API keys and other credentials are never exposed.
6. Test Real-World Scenarios
Test different situations, including:
- Different package weights and dimensions
- Domestic and international orders
- COD and prepaid orders
- Invalid addresses
- Duplicate shipment requests
- Failed API responses
- Tracking updates
7. Secure the Integration
Use HTTPS for all API communication and store API keys and credentials securely using environment variables or a proper secrets-management system.
8. Deploy and Monitor
Once testing is complete, move to production credentials and monitor the integration for failed requests, API errors and unexpected behaviour. Set up alerts so problems can be identified quickly.
Common Challenges
Shipping API integrations can present several technical challenges:
Authentication Issues
Credentials may work correctly in the sandbox but fail when the production account is activated. Production credentials and account settings should be tested before going live.
REST vs SOAP Complexity
REST APIs are generally simpler to work with, while older SOAP/XML APIs can require additional development time and more complex request handling.
Strict Data Validation
Some courier APIs have strict character limits or formatting requirements. Customer information that looks valid on your website may still be rejected by the courier API.
Sri Lankan Address Formats
Sri Lankan addresses don’t always follow a consistent format. Address data may need to be cleaned and normalized before being sent to the courier.
API Rate Limits
Repeatedly requesting shipping rates can create unnecessary API traffic. Caching rate responses where appropriate can reduce API calls and improve performance.
COD Reconciliation
COD amounts and shipment records need to remain synchronized between your store and the courier system. Poor synchronization can create reconciliation problems.
Duplicate Shipments
A failed request can sometimes be retried and accidentally create duplicate shipments. The integration should check existing shipment records before creating another shipment.
Label Printing Problems
Different couriers may generate labels with different dimensions and formats. Labels should be tested with the actual printers and paper sizes used by the business.
Costs and Timelines
Basic
$150–$400
- Single courier
- Creation
- Tracking
- Rate where supported
- Timeline: 1–2 weeks
Standard
$500–$1,200
- Rate comparison
- Auto labels
- Advance Tracking
- COD reconciliation
- Timeline: 2–4 weeks
Enterprise
$1,500–$3,000+
- Custom rules
- Returns Management
- Analytics
- Warehouse integration
- Timeline: 4–6 weeks+
Cost drivers: number of couriers, API type (REST vs. SOAP), platform (plugin vs. custom build), COD handling, automation depth, and testing scope. Scripterlab can scope an exact number after a short requirement call.
How Scripterlab Handles Shipping API Projects
Scripterlab builds shipping API integrations as part of its custom software and e-commerce development work, shipment creation, tracking, rate calculation and labels where supported, and COD reconciliation, for WooCommerce, Shopify, and fully custom systems. The process follows proper requirements scoping, sandbox-first development, real-scenario testing, and a security review before credentials touch a live server, including routing logic where couriers have different capabilities. Post-launch, we handle monitoring, courier-side changes, and future extensions like new couriers or returns workflows.
If manual courier portals have become your bottleneck, get in touch with Scripterlab or message us on WhatsApp at +94 710 882288.
FAQs about Shipping API integration
Which couriers actually offer usable APIs here?
Aramex and DHL are the most consistently documented for international shipping; Domex offers a solid REST API for domestic booking/tracking. Other local couriers vary, confirm directly before scoping around them.
Do I need an in-house developer afterward?
Not necessarily, most businesses just need staff to run day-to-day operations, with ongoing maintenance handled through a support arrangement.
Can I integrate multiple couriers?
Yes, and it’s usually the right call for mixed domestic/international volume.
Does every API support rates and labels?
No, Domex, for instance, currently supports booking and tracking only, not rate quotes or label printing.
