EndPoint - Delivery API
🌐 Our Environment
All Komerce API requests are made through a centralized base URL. Depending on the environment you are working in (production or sandbox/testing), you should direct your requests to the appropriate endpoint.
📌 Production Environment
This is the live environment where real delivery orders, shipping rate calculations, and plugin communications occur.
Base URL:
https://api.collaborator.komerce.id/
Use this URL when your integration is ready for production and has passed sandbox testing. All production requests must be authenticated with a valid production token.
🧪 Sandbox Environment
The sandbox environment is designed for testing purposes. No real shipments are created, and you can experiment safely with all endpoints.
Base URL:
https://api-sandbox.collaborator.komerce.id/
This endpoint behaves identically to production but operates in a separate, isolated environment.
🔁 Switching Between Environments
To switch environments, you only need to change the base URL in your requests:
- Use the sandbox URL during development or testing.
- Use the production URL when your app is live.
⚠️ Make sure to use the correct authentication APIKEY for each environment. Sandbox APIKEY won't work in production when you didn't have any approval access from our Administrator.
🛠 Example Usage
Here's a sample curl request to retrieve the list of available couriers in production:
curl --request GET \
--url https://api.collaborator.komerce.id/
--header 'x-api-key: YOUR_PRODUCTION_KEY'
For sandbox testing, just replace the base URL:
curl --request GET \
--url https://api-sandbox.collaborator.komerce.id/
--header 'x-api-key: YOUR_SANDBOX_KEY'
EndPoint
| Name | Path | Method | Description |
|---|---|---|---|
Search Destination | /tariff/api/v1/destination/ | GET | for Search origin or destination id |
Calculate | /tariff/api/v1/calculate | GET | for Search estimated shipping cost by origin and destination |
Store Order | /order/api/v1/orders/store | POST | for Submit an order's |
Cancel Order | /order/api/v1/orders/cancel | PUT | for Cancel an order's |
Detail Order | /order/api/v1/orders/detail | GET | for Getting more information about Submited order |
History AWB | /order/api/v1/orders/history-airway-bill | GET | for Checking track AWB |
Pickup Order | /order/api/v1/pickup/request | POST | for Request a order Pickup time |
Label Order | /order/api/v1/orders/print-label | POST | for Getting an label order's |
Webhook | /Used your webhook handler URL | PUT | for Getting automation respon's about the order's |
✅ Best Practices
- Always test new features or workflows in the sandbox before going live.
- Maintain separate credentials for sandbox and production.
- Never use sandbox credentials or URLs in your production app.
- Monitor responses and logs to ensure you're hitting the correct environment.
With the correct base URL and environment, you're now ready to explore Komerce's API capabilities.