Endpoint reference

Interactive API explorer → Prefer to click around? The explorer renders every endpoint with live schemas, parameters, and ready-to-copy code samples.

The tables below are a quick scan of the routes and filters. For full request/response schemas, the interactive explorer is the richer view.

OpenAPI spec

The full machine-readable contract is served publicly (no auth, no shop data) at:

GET https://prod.logistified.app/api/v1/openapi.json

Point Postman, Insomnia, or any OpenAPI 3.1 client at that URL to generate a typed client or browse every parameter and response shape.

Note

The spec is generated directly from the live API, so it always matches actual behaviour — the parameters and response fields it lists are exactly what you get.

Endpoints

All endpoints are GET and require a read-scope bearer token.

Purchase orders

Path	Returns
/api/v1/purchase-orders	List (filters: status, supplierId, search, dateFrom, dateTo, paidStatus, locationId, variantId, sku, limit, cursor)
/api/v1/purchase-orders/{id}	Full detail — header, line items, shipment, addresses, payments, documents
/api/v1/purchase-orders/{id}/line-items	Line items
/api/v1/purchase-orders/{id}/payments	Payments
/api/v1/purchase-orders/{id}/documents	Document metadata
/api/v1/purchase-orders/{id}/shipment	Shipment
/api/v1/purchase-orders/{id}/addresses	Billing + shipping addresses
/api/v1/purchase-orders/{id}/receipt-schedule	Receiving / incoming schedule
/api/v1/purchase-orders/{id}/log	Activity log
/api/v1/purchase-orders/{id}/credits	Applied + available supplier credits

Stock takes

Path	Returns
/api/v1/stock-takes	List (filters: status, locationId, search, limit, cursor)
/api/v1/stock-takes/reasons	Configured stock-take reasons
/api/v1/stock-takes/{id}	Full detail — header + line items
/api/v1/stock-takes/{id}/line-items	Line items

Transfer orders

Path	Returns
/api/v1/transfer-orders	List (filters: status, search, dateFrom, dateTo, fromLocationId, toLocationId, variantId, sku, limit, cursor)
/api/v1/transfer-orders/{id}	Full detail — header (incl. line items), addresses, log
/api/v1/transfer-orders/{id}/line-items	Line items
/api/v1/transfer-orders/{id}/shipment	Shipment
/api/v1/transfer-orders/{id}/documents	Document metadata
/api/v1/transfer-orders/{id}/addresses	From + to addresses
/api/v1/transfer-orders/{id}/log	Activity log

Back to overview