Introduction
Skuflo tracks production, stock and dispatch for manufacturers, and gives every retailer they supply a free live portal. The API is how you push orders in, scan pieces from your own hardware, and get told the moment something changes.
What the API is for#
Every piece a factory makes gets a label. As that label is scanned made, into stock and loaded onto a vehicle, Skuflo keeps the order it belongs to up to date and tells anyone who needs to know. The API gives you three things:
- Push a retailer’s order in as JSON, or read back its state at any point.
- Record a scan from your own hardware, if you are not using a Skuflo tablet or phone.
- Receive a signed webhook the moment a piece or an order changes state, so your own systems never have to poll.
Base URL and versioning#
Every request goes to https://api.skuflo.io.
Every path is prefixed /v1. There is one version live today. A breaking change to a response shape would arrive as /v2, with /v1 kept running: see the changelog for what has shipped so far.
Three ways to integrate#
A factory API key (sk_live_...) authenticates as your factory, with full access to its data: push orders, read anything, manage retailers. See Authentication.
A scan station token (st_live_...) is locked to one job: recording scans from a piece of hardware you built yourself. See Scanning from your own hardware.
A webhook is Skuflo calling you: register an endpoint once and every event you asked for is POSTed to it, signed, with retries if you are briefly down. See Webhooks.
Where to go next#
New integration: start with Authentication, then POST /v1/orders/import to push your first order. Building scan hardware: go straight to Scanning from your own hardware. Otherwise, the full endpoint list is in the sidebar, grouped the way the product is: Orders, Labels, Production, Stock, Loads and so on. Press Ctrl K or ⌘K to search all of it.