StockroomAPIOpen the app
Reference

Every endpoint

59 endpoints under https://api.stockroom.app/v2, in 8 sections. Every one takes a bearer key, and every refusal is one Error envelope with a code you can branch on.

#Account

The key itself: which store it belongs to, what it may do, and when it expires. GET /v2/whoami is the cheapest way to prove a key works.

GETWhich store and key this is/whoami

#Suppliers

Suppliers and their per-supplier catalogs: supplier SKU, cost, minimum order quantity and pack size. Archive, unarchive and merge are actions rather than fields; nothing in Stockroom deletes a supplier.

GETList suppliers/suppliersPOSTCreate a supplier/suppliersPOSTMerge suppliers/suppliers/mergeGETGet a supplier/suppliers/{id}PATCHUpdate a supplier/suppliers/{id}POSTArchive a supplier/suppliers/{id}/archivePOSTRestore an archived supplier/suppliers/{id}/unarchiveGETList a supplier's catalog/suppliers/{id}/catalogPUTAdd or update catalog rows/suppliers/{id}/catalogDELETERemove an item from a supplier's catalog/suppliers/{id}/catalog/{inventory_item_id}

#Purchase orders

Drafts, lines, charges and the whole lifecycle: send, mark ordered, mark on the way, close, reopen, cancel what is left, archive, duplicate. Each move is its own call, and an illegal one is 422 invalid_transition rather than a silent write.

GETList purchase orders/purchase_ordersPOSTCreate a purchase order/purchase_ordersGETGet a purchase order/purchase_orders/{id}PATCHUpdate a purchase order/purchase_orders/{id}DELETEDelete a draft/purchase_orders/{id}GETAn order's history/purchase_orders/{id}/historyGETThe order as a PDF/purchase_orders/{id}/pdfPOSTAdd lines to an open order/purchase_orders/{id}/linesPOSTCancel what is still outstanding on a line/purchase_orders/{id}/lines/{line_id}/cancel_remainingPOSTEmail the order to the supplier/purchase_orders/{id}/sendPOSTMark a draft ordered/purchase_orders/{id}/mark_orderedPOSTRecord a shipment/purchase_orders/{id}/mark_in_transitPOSTClose an order/purchase_orders/{id}/closePOSTReopen a closed order/purchase_orders/{id}/reopenPOSTArchive an order/purchase_orders/{id}/archivePOSTUnarchive an order/purchase_orders/{id}/unarchivePOSTDuplicate an order as a new draft/purchase_orders/{id}/duplicate

#Receipts

One record per delivery against a purchase order: what came in, to where, on what date, at what cost. Recording a receipt moves stock, so it requires an Idempotency-Key; voiding one reverses the movement instead of editing a number back down.

GETList an order's receipts/purchase_orders/{id}/receiptsPOSTRecord a receipt/purchase_orders/{id}/receiptsGETGet a receipt/purchase_orders/{id}/receipts/{receipt_id}POSTVoid a receipt/purchase_orders/{id}/receipts/{receipt_id}/void

#Payments

Payments recorded against a purchase order, one row each, so a part payment is expressible. The order's payment_status and paid_at follow from the rows; mark paid and mark unpaid are the shortcuts.

GETList an order's payments/purchase_orders/{id}/paymentsPOSTRecord a payment/purchase_orders/{id}/paymentsDELETEDelete a payment/purchase_orders/{id}/payments/{payment_id}POSTMark an order paid/purchase_orders/{id}/mark_paidPOSTMark an order unpaid/purchase_orders/{id}/mark_unpaid

#Stock adjustments

A signed delta per line, drafted and then applied. Applying moves stock and requires an Idempotency-Key. Stockroom adjusts by a delta and never sets an absolute level.

GETList stock adjustments/stock_adjustmentsPOSTCreate a draft adjustment/stock_adjustmentsGETGet a stock adjustment/stock_adjustments/{id}PATCHUpdate a draft adjustment/stock_adjustments/{id}POSTApply a draft/stock_adjustments/{id}/applyPOSTCancel a draft/stock_adjustments/{id}/cancel

#Catalog

Read-only mirror of the store's Shopify products, variants, locations and inventory levels. It may lag Shopify by a few seconds. To change catalog data, write to Shopify's Admin API.

GETList products/productsGETGet a product/products/{id}GETList variants/variantsGETGet a variant/variants/{id}GETList locations/locationsGETGet a location/locations/{id}GETList inventory levels/inventory_levels

#Webhooks

Subscriptions to a URL, the delivery log, a test event and redelivery. The signing secret is in the creation response and nowhere else.

GETList webhooks/webhooksPOSTCreate a webhook/webhooksGETGet a webhook/webhooks/{id}PATCHUpdate a webhook/webhooks/{id}DELETEDelete a webhook/webhooks/{id}GETA webhook's delivery log/webhooks/{id}/deliveriesPOSTRetry one delivery's event now/webhooks/{id}/deliveries/{delivery_id}/redeliverPOSTResend past events/webhooks/{id}/redeliverPOSTSend a test event/webhooks/{id}/test

Shapes

The named shapes an answer is made of: a supplier, a purchase order, a receipt, an adjustment, a webhook.

string (date-time) or nullTimestampstring (date) or nullDatestring or nullMoneynumber or nullQuantity3 fieldsSyncState2 fieldsLocationRef1 fieldsError3 fieldsWhoamienumScope32 fieldsSupplier31 fieldsSupplierInput12 fieldsSupplierCatalogRow4 fieldsPriceTierSet9 fieldsSupplierCatalogRowInputenumPurchaseOrderStatus38 fieldsPurchaseOrderSummary40 fieldsPurchaseOrder24 fieldsPurchaseOrderLine9 fieldsPurchaseOrderCharge8 fieldsPayment5 fieldsHistoryRow24 fieldsPurchaseOrderInput18 fieldsPurchaseOrderLineInput7 fieldsPurchaseOrderChargeInput14 fieldsReceipt11 fieldsReceiptInput17 fieldsStockAdjustment4 fieldsStockAdjustmentInput14 fieldsProduct20 fieldsVariant7 fieldsLocation9 fieldsInventoryLevelenumWebhookEvent13 fieldsWebhook14 fieldsWebhookWithSecret3 fieldsWebhookInput11 fieldsWebhookDelivery1 fieldsRedeliverResult6 fieldsWebhookEnvelopePayload10 fieldsItemCondition