API reference
Every Shipping Engine endpoint and webhook event, generated from the OpenAPI spec.
- Product
- APIShipping Engine API
- Section
- API reference
- Reading time
- 1 min read
Each endpoint page lists every parameter and response field, real error messages, code samples in several languages, and a playground to send requests to the sandbox.
Base URLs: sandbox https://sandbox-api.fastrac.example, production https://api.fastrac.example.
Authentication: Authorization: Bearer <access_token> (see Authentication).
Responses: wrapped in { "statusCode", "message", "data" } (see Requests and responses).
| Area | Endpoints |
|---|---|
| Regions | Search regions · Provinces · Cities · Districts · Subdistricts · Postcode lookup |
| Couriers and catalog | Couriers · Courier services · Package types |
| Shipping rates | Get shipping rates · Retrieve a rate |
| Orders | Create an order · Cancel an order |
| Shipments | List · Retrieve · Track · Cancel · Simulate a status (sandbox) |
| Balance | Retrieve balance · Balance logs |
| Webhooks | Retrieve endpoint · Register endpoint |
Webhook events are listed at the bottom of the sidebar, and explained in the event catalog.
Download the spec
The full OpenAPI 3.1 document is available at /openapi/shipping-engine.yaml.
Import it into Postman, Insomnia or your code generator.
Was this page helpful?
API changelog
Changes to the Shipping Engine API and webhooks, newest first.
Search regions GET
Free-text search over Indonesian subdistricts (kelurahan/desa). Use the returned `id` as `subdistrictId` in a rate request. This is the fastest way to turn an address typed by a user into a region. No authentication is required. Results are paginated: pass `nextCursor` back as `cursor` until it is `null`.