Rate limits
The Helthjem API does not currently publish fixed rate limits for its public endpoints. To keep the service fast and reliable for everyone, follow the guidance on this page. We may limit clients that send excessive traffic.
Guidelines
| Do | Don't |
|---|---|
| Cache your access token and reuse it for 12–24 hours. | Request a new token for every API call. |
| Call Single Address Check once the consumer has entered a complete address. | Call it on every keystroke while the address is being typed. |
| Cache nearby service points for an address during the checkout session. | Fetch them again every time the checkout page reloads. |
Book each shipment once, and use an idempotency-key when you retry. |
Retry bookings in a tight loop. |
| Poll tracking at a sensible interval, and stop when the parcel reaches a final state. | Poll every parcel every minute. |
| Spread bulk jobs, such as printing many labels, over time. | Send hundreds of requests at the same moment. |
Tracking polling
The API doesn't push tracking updates, so you need to poll. We recommend:
- Poll active parcels every 1–4 hours.
- Use
onlyLastEvent=truewhen you only need the current status. - Stop polling when the parcel reaches a final state: Delivered, Cancelled, or returned to the sender. See Recommended UI states.
If you are limited
If you send too many requests, the API may respond with 429 Too Many Requests. Wait before you retry, and use exponential backoff.
Last updated
