Zum Inhalt springen
Web APIOrders

Orders

Orders and their tracking: the transponders assigned to them, their latest positions and their recorded paths.

10 operationsBase https://api.locantra.de

Get one order

GEThttps://api.locantra.de/order
Permission orders.read

Returns a single order, looked up by ID or by Name. Give exactly one of them.

Create an order

POSThttps://api.locantra.de/order
Permission orders.manageIdempotent

Creates an order and, optionally, one transponder assignment per chip code in Transponders. A chip code that is still assigned elsewhere is rejected with 409. Category and Tags classify the order; both are optional free text, and Tags are trimmed and deduplicated before they are stored.

Update an order

PATCHhttps://api.locantra.de/order
Permission orders.manage

Changes an order's name, category or tags. Name is required on every request; Category and Tags are left unchanged when the body omits them, and are cleared by an empty string and an empty array respectively.

Delete an order

DELETEhttps://api.locantra.de/order
Permission orders.manage

Deletes an order. Its transponder assignments are not deleted with it.

Get the recorded path of an order's transponders

GEThttps://api.locantra.de/order/path
Permission orders.read

Returns the recorded positions of an order's transponder assignments over time, keyed by assignment ID. ID is the order's own ID. AssignmentID filters by an assignment's own ID, not by the chip code printed on the transponder; repeat the parameter for several, at most 200 per request. Limit (default 100, maximum 1000) caps the positions returned per assignment.

Get the latest position of every transponder on an order

GEThttps://api.locantra.de/order/pings/latest
Permission orders.read

Returns the most recent recorded position of each transponder assignment on one order, keyed by assignment ID. ID is the order's own ID. AssignmentID filters by an assignment's own ID, not by the chip code printed on the transponder; repeat the parameter for several, at most 200 per request.

Get the latest position of one transponder assignment

GEThttps://api.locantra.de/order/position
Permission orders.read

Returns the most recent recorded position of one transponder assignment. AssignmentID is the assignment's own ID, not the chip code printed on the transponder.

Get an order with its transponder assignments

GEThttps://api.locantra.de/order/summary
Permission orders.read

Returns one order together with every transponder assignment that belongs to it.

List orders

GEThttps://api.locantra.de/orders
Permission orders.read

Lists the orders of your organisation. Give at least one filter or All=true. ID, Name and CreatedBy each take at most 200 values per request. Category selects orders in any of the given categories and Tag orders carrying at least one of the given tags; each takes at most 50 values per request. Results are paged with Limit (default 100, maximum 1000) and Offset; the response envelope's Page carries the applied Limit and the Total match count. IncludeActivity=true returns order activity summaries instead of plain orders.

List orders with their tracking activity

GEThttps://api.locantra.de/orders/activity
Permission orders.read

Lists orders enriched with detection counts and the latest recorded position, for sorting by real activity rather than by administrative changes. Results are paged with Limit (default 100, maximum 1000) and Offset. LatestAssignmentID is an assignment's own ID; LatestTransponderID is the physical chip code.