REST API
The REST API lets you work with your Assemblified data over plain HTTP: GET or PATCH a URL, get JSON back, without speaking MCP or writing code-mode programs. It’s the same data and the same asmk_ keys as AI / Agent access, exposed as ordinary REST resources.
v1 serves:
- raw materialsRaw materialThe atomic component of a bill of materials or an assembly bill. Two flavours: a Shopify-linked variant, whose inventory Shopify tracks, or a virtual material, which Assemblified tracks on its own and Shopify never sees. Both sit in the same component picker and are consumed the same way. Read more → — read every material, update your virtualVirtual MaterialA material tracked entirely inside Assemblified — not a Shopify variant. Useful for shop-floor consumables (glue, packaging, labour units) where you need quantity tracking but don't want a Shopify product on your storefront. Read more → ones;
- inventory per location — stock levels, pre-assembledPre-Assembled InventoryStock of finished goods and assembly bills already built and on the shelf, counted per location. A work order draws assembly bills from the shelf first, building fresh only if it runs short; an order consumes a finished good's shelf before its components. Read more → units, fractional remainders, what is committed to orders and reservations, what is allocated in shelf stock, and what open work orders have tied up;
- bills of materialsBill of MaterialsA bill of materials tells Assemblified how to build one unit of a finished good. When a customer orders the finished-good variant, Assemblified deducts the right component quantities from inventory automatically. Read more → — the fully hydrated recipe, the computed max-buildable, and the per-location rules configured on a bill;
- per-order BOM breakdowns — what a warehouse has to pack;
- work ordersWork OrderA planned production run: pick materials, build the items, do QC, and complete — all tracked together. Use work orders when you're building stock ahead of demand or running a multi-day project. Read more → — the list, one whole work order, its material plan and its build runs, plus three writes: edit the header, move it to another state, and start a build run;
- the supporting lists — your locations, your assignees, and the index of a bill’s saved versions.
Base URL
Section titled “Base URL”https://assemblified.com/api/v1A first request
Section titled “A first request”Authenticate with an asmk_ API key (see Authentication):
curl -s -H "Authorization: Bearer $ASMK_TOKEN" \ "https://assemblified.com/api/v1/raw-materials?pageSize=5"Every successful response is wrapped in a small envelope:
{ "data": { "items": [ /* … */ ], "totalCount": 42, "page": 1, "pageSize": 5, "totalPages": 9, "availableVendors": [ /* … */ ] }, "meta": { "requestId": "…", "apiVersion": "1.2" }}What you can do
Section titled “What you can do” Read raw materials List with filters + pagination, get one (with its BOM / assembly-bill connections), both Shopify-linked and virtual.
Read inventory levels Real per-location stock for any material — live from Shopify for Shopify-linked, app-local for virtual.
Update virtual materials PATCH fields (name, sku, cost, unit, …) and set per-location stock — for VMAT-* materials only.
Read bills of materials List BOMs, get one with its fully hydrated recipe (recursive assembly bills + cost factors), and compute the per-location max-buildable.
Read order BOM breakdowns What a warehouse must pack per order — the metafield-parity breakdown for 1–50 orders per call, computed live.
Read pre-assembled stock Units already built and on the shelf, per location — for a finished good or an assembly bill.
Resolve your locations The id → name list every per-location filter keys on, plus the fractional-remainder read for materials.
Read work orders The list with its facets, one whole work order, its material plan and its build-run history.
Update a work order Edit the header, move it to another state, or start a build run — each with an optimistic-lock token.
Read what stock is spoken for Per location: committed to orders and reservations, embedded in shelf stock, and tied up in open work orders.
Read a bill's version index Every saved version of one bill with its change summary — and your assignee list.
How it relates to AI / Agent access
Section titled “How it relates to AI / Agent access”The REST API and the Agent access surface share the same asmk_ API keys, the same read/write scopes, and the same per-shop rate limit, and are backed by the same operations — a change made over REST is exactly the change the app UI or an AI assistant would make. If you already use Agent access, your keys work here unchanged (REST additionally requires the Enhanced plan).
Where to next
Section titled “Where to next” Interactive API explorer → Browse and try every endpoint — live schemas, parameters, and copy-paste code samples.