Divoox Flex: the API to connect your own system
If your business already runs its own system, it can create and query shipments and packages directly with an integration key, without the panel.
How it works
In âAPIâ you create an integration key. It is shown only once: copy it and store it in your system. Each key has scoped permissions (create shipments, read them, record steps, import, manage hubs and batches) and can never manage your team or money. You can revoke it at any time.
The key travels in a header on every call. Calls that create something also require an idempotency key with a unique value per operation: if you repeat the same call, you get the same response with nothing duplicated. We hand the full technical reference, with paths and examples, to your integrator from the panel.
Available operations: create one shipment or several in a single call (up to twenty-five), list and read shipments and packages, record a custody step, get label data, resolve a scanned code, import a sheet in two steps (preview and confirm) and manage draft batches and routes.
There is a limit of sixty calls per minute per key. Errors come in plain words, in the language you ask for with the âx-idiomaâ header (en or es).
The recipient can check the status of their package with its tracking code; that query shows only the status and dates, never personal data.
Steps
- In your company panel open âAPIâ, create a key with the permissions you need and copy it.
- Send your calls with your key and, on the ones that create things, with an idempotency key unique per operation.
- Create shipments with the recipient name, the address and the number of packages; store the codes that come back.
- Query each packageâs status whenever you need it and record its steps from your system.
Divoox can also notify your system of every change: set it up in âIntegrationsâ (see ânotifications, suggested order, capacity and operations metricsâ).
This guide answers
- How do I connect my system to Divoox Flex?
- What can an API key do?
- How do I avoid creating duplicate shipments?