Topic
Developers & integrations
API v1, webhooks, API keys, CSV imports and connecting your own systems. 27 articles.
How-to guides
- Quickstart: place your first order with curlCreate a key, ask for a price, place an order, read it back and cancel it, with copy-paste curl commands.Company admin
- Verify webhook signaturesHow a NemiRoute webhook is signed, how to check the signature with curl, Node.js and Python, how to handle secret rotation and replays, and a test vector.Company admin
Concepts
- API keys, permissions and scopesHow a key is sent, what the three scopes allow, the contact a key acts as, rotation, revocation and the access checks made on every call.Company admin
- Pagination, filters and data formatsPage size and paging, filtering and syncing orders, and the formats of dates, money, weights, addresses and ids used across the API.Company admin
- Order import file formatThe rules for a CSV or Excel file of orders: file types, header row, dates, numbers, weights, yes/no values, addresses, what one row can hold and how the import checks and undoes a file.Company admin
- API errors and codesThe error body, every HTTP status and error code the customer API returns, the details.reason values and how to handle each.Company admin
- Safe retries with Idempotency-KeyHow to retry POST /orders without ever placing a second order, how long a key is remembered and what a replayed answer looks like.Company admin
- What NemiRoute integrates withEvery connection NemiRoute has today, which way data flows, who sets it up and where to read more: customer API, webhooks, file import, Stripe, accounting exports, email, texts, maps and push.Company admin
- Multi-stop orders in the APIHow to send an order with extra pickups, drops and a return leg using the stops array, and how the stops come back with their progress.Company admin
- API v1 overviewWhat the NemiRoute customer API can do, where it lives, how a request and a response look, and which plan and keys you need.Company admin
- Place an order with the APIHow to build the body of POST /orders: addresses, services, package types and weights, time windows, proof, cash on delivery, references, custom fields and the answer you get.Company admin
- Prices, quotes and tax in the APIHow POST /orders/quote works, what each price field means, how tax is shown, price-change protection and what a hidden price looks like.Company admin
- API rate limitsHow many calls a key may make per minute, what a 429 answer looks like, the headers that come with it and how to back off.Company admin
- Read, track, sync and cancel orders with the APIRead one order or a list, filter and sync changes, understand statuses, ETA, failure and proof of delivery, download labels and cancel an order.Company admin
- API reference: address bookThe address-book endpoints of API v1: list, add, read, edit and remove addresses, with the fields and rules of each.Company admin
- API reference: place an order and get a quoteEvery field you can send when placing or quoting an order in API v1, the response of each, and a curl example.Company admin
- CSV import: every columnThe columns of the order import file (CSV or Excel): header, whether it is required, the other header names that are matched automatically, and an example.Company admin
- API reference: labels and proof of deliveryThe PDF endpoints of API v1: one shipping label, labels for up to 50 orders, and the proof-of-delivery document.Company admin
- API reference: the order objectEvery field of the order your API returns, including tracking link, ETA, failure, proof of delivery, stops and custom fields.Company admin
- API reference: list, read and cancel ordersThe endpoints that list, read and cancel orders in API v1, with parameters, responses and a curl example each.Company admin
- API reference: webhook payloadThe JSON body of every webhook call: the envelope, the order and invoice objects, and what each field holds.Company admin
- Tracking links for receiversWhat the trackingUrl of an order is, how it is built and protected, how receivers get it and how to share it from your own system.Company admin
- Webhook retries, delivery log and replayThe retry schedule, delivery statuses, what the delivery log keeps, how to replay a delivery, how an endpoint is switched off and how to rotate the signing secret safely.Company admin
- Webhook events and payloadsEvery webhook event with when it fires, the headers of a call, the JSON body of each event (order, invoice, test) and the older version 1 body.Company admin
- Webhooks overviewHow webhooks push order and invoice events to your server, who can set them up, the URL rules, limits, delivery guarantees and a checklist for a good receiver.Company admin
Troubleshooting
- Fix order import errorsEach error message of the order import (file, column matching and row errors) with its cause and how to fix the file.Company admin
- Troubleshoot API callsSymptom, cause and fix for the API problems integrators hit most: 401, 403, 409, 422 and 429 answers, orders that look duplicated, missing prices and webhooks that stop.Company admin