Documentation
Step-by-step guides to every part of the product, from your first shipment to inviting your team. Building an integration? Go straight to the API reference.
Every endpoint an API key can call, with examples.
What changed in each version.
Start here
The big picture, in one minute.
The platform follows your shipments across carriers and puts their status in one place. Your team works in the dashboard; your own systems talk to it through the API.
Everything belongs to an organization. Members of an organization share its shipments, carrier accounts, API keys and billing. Each member has a role (Admin, Developer, Reporter or Reader) that decides what they can change; see Roles and permissions below.
Start here
From sign-up to your first tracked shipment.
Start here
Logging in, Google sign-in and resetting a password.
Daily operations
Add, find, read and manage the shipments you track.
Who: Everyone can view shipments. Admins and Developers can create, retrack, delete and start returns.
Adding many shipments at once is available through the API (up to 100 per request, see the API reference). The dashboard adds them one at a time.
| Status | Meaning |
|---|---|
| pending / unknown | Added, but no carrier scan yet (or the carrier has not recognized it). |
| label_created / pre_transit | The carrier has the label or the data, the parcel has not moved. |
| picked_up / in_transit | The parcel is with the carrier and moving. |
| out_for_delivery | On the vehicle for delivery today. |
| available_for_pickup | Waiting at a pickup point. |
| delivered | Delivered. |
| exception / failed | A problem: delay, hold or failed delivery attempt. An exception is opened. |
| return_to_sender / returned | On its way back to you, or back. |
| cancelled | The shipment was cancelled. |
Daily operations
Ask the carrier for fresh scans right now.
Who: Admins and Developers.
The platform already checks every active shipment on a schedule (see How tracking stays up to date). Retrack is for when you do not want to wait, for example a customer is on the phone and you want the latest scan.
Daily operations
What happens between "created" and "delivered".
Daily operations
Work delays, holds and failed deliveries before customers ask.
Who: Everyone can view. Admins and Developers can act.
An exception is opened automatically when a shipment moves to the exception or failed status. You cannot create one by hand. Its type and severity (Critical, High, Medium, Low) come from the carrier scan, for example a failed delivery attempt is High. When the shipment is delivered, its open exceptions close on their own.
| From | You can move it to |
|---|---|
| Open | Acknowledged, In progress, Dismissed |
| Acknowledged | In progress, Resolved |
| In progress | Resolved |
| Resolved, Dismissed | Final: no further changes |
Daily operations
Start and follow a return from request to received.
Who: Everyone can view. Admins and Developers can start and move returns. Needs a plan that includes returns.
| Status | Next steps (button in the side panel) |
|---|---|
| requested | "Move to review", Approve, Reject, "Cancel return" |
| pending_approval | Approve, Reject, "Cancel return" |
| approved | "Mark label generated", "Cancel return" |
| label_generated | "Mark in transit", "Cancel return" |
| in_transit | "Mark received" |
| rejected, received, cancelled | Final |
Daily operations
Answer "where is my parcel?" for any shipment of yours.
Daily operations
Delivery performance and carrier comparisons.
Who: Admins, Developers and Reporters. Readers do not see Reports.
Customers
Tell customers where their parcel is, automatically.
Who: Admins and Developers only.
Open Notifications ("Customer notifications"). It has three tabs: Channels, Templates and "Delivery log".
Customers
Ask customers how it went, and read their answers.
Who: Admins and Developers design forms. Admins, Developers and Reporters read the results. Only Admins delete answers. Needs a plan that includes feedback forms.
A feedback form is a short set of questions you design once. When a shipment reaches a status you choose (for example Delivered), the customer is emailed a personal link to the form. Their answers appear under Feedback, with a summary for every question.
Integrations
See supported carriers and connect your own accounts.
Who: Everyone can look. Admins and Developers connect and validate; only Admins disconnect.
The Carriers page has three tabs: Carriers (the catalog), Accounts (yours) and "Fallback providers". You do not need your own carrier account to track: the platform tracks through its own providers. Connecting your account is for when you want the carrier to see requests as coming from you. It needs a plan that includes your own carrier accounts.
Integrations
Let your own systems call the API.
Who: Admins and Developers. Needs a plan that includes API access.
Integrations
Get events sent to your server as they happen.
Who: Admins and Developers. Needs a plan that includes webhooks.
Administration
Add colleagues and choose what they can do.
Who: Admins only.
The person receives an email with their sign-in details and a generated password. They sign in, land in your organization with the role you chose, and can set their own password with the forgot-password link.
Administration
Who can see and do what.
| Admin | Developer | Reporter | Reader | |
|---|---|---|---|---|
| View shipments, exceptions, returns, tracking lookup | Yes | Yes | Yes | Yes (shipments) |
| Create, retrack and delete shipments | Yes | Yes | No | No |
| Work exceptions and returns | Yes | Yes | No | No |
| Reports and exports | Yes | Yes | Yes | No |
| Notifications and templates | Yes | Yes | No | No |
| Design customer feedback forms | Yes | Yes | No | No |
| Read customer feedback results | Yes | Yes | Yes | No |
| Delete a feedback response | Yes | No | No | No |
| Connect and validate carrier accounts | Yes | Yes | No | No |
| API keys and webhooks | Yes | Yes | No | No |
| Disconnect carrier accounts | Yes | No | No | No |
| Invite and manage members | Yes | No | No | No |
| Billing changes and invoices | Yes | No | No | No |
| Activity log | Yes | No | No | No |
Administration
Protect your account with an authenticator app.
Administration
Usage, changing plan, cancelling and invoices.
Who: Everyone can view usage. Only Admins can change anything or see invoices.
Administration
See who did what in your organization.
Who: Admins only.
Open the Activity Ledger ("Activity log"). Filter by category and by result (success, failure, denied) or search the page. Each entry shows when it happened, who did it, what it touched, the result and where it came from (IP address and browser), so you can answer "who changed this?".
Reference
Move around without the mouse.
Press Ctrl/Cmd + K to open the command palette ("Jump to a page…"), type to filter, use the arrow keys and press Enter. Or press G, then a letter within a second. Shortcuts are ignored while you are typing in a field, and pages your role cannot use are left out.
| Keys | Goes to |
|---|---|
| G O | Dashboard |
| G S | Shipments |
| G E | Exceptions |
| G R | Returns |
| G N | Notifications |
| G F | Feedback |
| G T | Tracking Pages |
| G C | Carriers |
| G D | Developer Tools |
| G W | Webhooks |
| G P | Reports |
| G H | Docs |
| G K | API Docs |
| G , | Org Settings |
| G M | Team & Access |
| G B | Billing & Usage |
| G A | Activity Ledger |
Reference
Quick answers to common questions.
| If… | Then… |
|---|---|
| A shipment shows no scans | It may be too new, or the carrier has not scanned it. Click Retrack. If the carrier is not set, choose it on the shipment. |
| Retrack says to try again in a minute | The shipment was just refreshed. Wait a minute. |
| Retrack is refused | The shipment is finished, archived or older than 60 days. |
| Creating a shipment is refused | You have used your plan's shipments for this period. Check Billing & Usage. |
| A customer did not get a message | Check the shipment has the customer email or phone, the channel is Configured, that status's switch is on, notifications are not paused, and the scan was less than 48 hours old. |
| I cannot see a page or button | Your role does not allow it, or your plan does not include the feature. Ask an Admin. |
| "Invite member" is disabled | The organization has reached its member limit, which pending invitations count towards. Remove a member, cancel an invitation, or ask us for more invite slots. |
| A customer did not get the feedback form | Check the form is Active and lists the status the shipment reached, the shipment has a customer email, the customer has not opted out, and the scan was less than 48 hours old. Each shipment is asked once per form. |
| A feedback link says it is no longer available | It was already used, it expired after 30 days, or feedback forms were switched off for your organization. |
| I lost my 2FA device | Sign in with a recovery code, turn 2FA off, then set it up again. |
| An API key stopped working | It may have been revoked or expired, or its rotation grace period of 24 hours ended. |