Skip to content

getrollmark.com(opens in a new tab)

03API reference

Version 1.0.0For developers

Rollmark API reference

The Rollmark API lets a dealer's website, plugin or inventory system work with the dealer's own data: the catalog as the store lists it, FFL Checkout (find an FFL, send the order a shopper made with a chosen FFL) and, as they are added, orders, distributor-order drafts, hand-managed stock and webhooks.

This file is the single source. The reference on docs.getrollmark.com is rendered from it, and the dealer app's tests check every route against it, so the documentation cannot drift from the code.

Versioning promise (v1). New endpoints, new optional request fields, new response fields, new event types and new permissions may be added. Nothing is removed or renamed, and nothing changes meaning. Ignore response fields you do not know. A deprecation is announced at least six months before anything stops working, with Deprecation and Sunset response headers.

Errors. The FFL Checkout routes and every route added after v1.0 answer { "error": { "code", "message", "request_id" } }. The three catalog routes keep their original body, a bare word in error (unauthorized, forbidden, not_found, rate_limited, bad_request, setting_up, unavailable), and add error_detail: { code, message }; the request id is in the X-Request-Id header.

Catalog

GET/productsSearch the store's products GET/products/{key}One product GET/staff/products/{key}One product with what only the store may see (private key)

FFL Checkout

GET/checkout/fflsFFLs near a ZIP GET/checkout/ffls/{id}One FFL GET/checkout/preferredThe dealer's preferred FFLs POST/checkout/ordersSend the order a shopper made with a chosen FFL GET/checkout/orders/{id}Where an order stands POST/checkout/orders/{id}/matchThe store's own order now exists

Orders

GET/ordersList orders POST/ordersSend an order GET/orders/{id}One order GET/orders/{id}/fillWhere each line stands POST/orders/{id}/matchMatch an order to your store's order POST/orders/{id}/cancelCancel an order POST/orders/{id}/readyMark ready to ship POST/orders/{id}/shipMark shipped POST/orders/{id}/deliverFinish as delivered POST/orders/{id}/linesAdd an item to an order PATCH/orders/{id}/lines/{line_no}Change a line DELETE/orders/{id}/lines/{line_no}Remove a line

Inventory

GET/inventory/itemsList stock items GET/inventory/items/{external_id}One stock item PUT/inventory/items/{external_id}Create or update a hand-managed item PATCH/inventory/items/{external_id}Change a hand-managed item DELETE/inventory/items/{external_id}Remove a hand-managed item POST/inventory/items/{external_id}/zeroSet the quantity to zero POST/inventory/batchChange many items at once

Webhooks

GET/webhooksList webhook endpoints POST/webhooksRegister a webhook endpoint GET/webhooks/{id}One webhook endpoint PATCH/webhooks/{id}Change a webhook endpoint DELETE/webhooks/{id}Remove a webhook endpoint POST/webhooks/{id}/testSend a test event POST/webhooks/{id}/rotate-secretRotate the signing secret GET/webhooks/{id}/deliveriesThe delivery log POST/webhooks/{id}/deliveries/{delivery_id}/resendSend a delivery again

Distributor orders

GET/distributor-ordersList distributor orders POST/distributor-orders/draftsMake drafts from order lines GET/distributor-orders/{id}One distributor order DELETE/distributor-orders/{id}Delete a draft POST/distributor-orders/{id}/linesAdd an order line to a draft DELETE/distributor-orders/{id}/lines/{line_no}Remove a line from a draft

Meta

GET/meWho this key is GET/openapi.jsonThis definition