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

GET endpoints need a read-scope bearer token (a write key works too). POST / PATCH / DELETE need a write-scope token.

Purchase orders — reading

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

Purchase orders — writing

Path	Does
POST /api/v1/purchase-orders	Create a draft. 201 + Location. An empty body {} is a valid empty draft
PATCH /api/v1/purchase-orders/{id}	Update header fields (at least one). status is not accepted here
DELETE /api/v1/purchase-orders/{id}	Delete a Draft outright, or soft-delete a Cancelled order
POST /api/v1/purchase-orders/{id}/line-items	Add catalog line items (bulk, 1–500). 201
POST /api/v1/purchase-orders/{id}/line-items/custom	Add one non-catalog line. 201
PATCH /api/v1/purchase-orders/{id}/line-items	Update line items (bulk, 1–500). updateSupplier: true also writes the supplier-related values back to the supplier’s catalogue
DELETE /api/v1/purchase-orders/{id}/line-items?lineItemIds=a,b	Delete line items (bulk). Can partly succeed — check failed[]
POST /api/v1/purchase-orders/{id}/status	Move the order’s status
POST /api/v1/purchase-orders/{id}/confirm	Record confirmed quantities — lines or confirmAll
POST /api/v1/purchase-orders/{id}/receive	Record received quantities (absolute totals)
POST /api/v1/purchase-orders/{id}/unreceive	Take back received quantities (deltas)
POST /api/v1/purchase-orders/{id}/complete	Complete the order and run the cost sync
POST /api/v1/purchase-orders/{id}/quick-complete	Receive + sync + complete, in one call from In Progress
POST /api/v1/purchase-orders/{id}/shopify-sync	Push received quantities to Shopify
POST /api/v1/purchase-orders/{id}/shopify-sync/reset	Clear the sync bookkeeping (Shopify untouched)

Purchase-order lifecycle → What each status allows, reopening a paused order, and the rules that trip people up.

Stock takes

Read-only.

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

Read-only.

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