IronRegisterGet Started

API docs

Sandbox

The sandbox is a separate Iron Register server for building and testing integrations. It has no real shops and no real customers. Nothing you do there touches a live store.
API base URL https://sandbox.ironregister.com/api/v1
Back office https://sandbox.ironregister.com
Keys ir_test_…, which only work here. Live keys get 401 WRONG_ENVIRONMENT.
Webhooks Delivered for real, signed the same way, with livemode: false

Your own sandbox shop

Each development partner gets their own sandbox shop:

  • A fictional gun store with two locations.
  • A catalog of firearms, ammunition and accessories.
  • Customers, and weeks of sales history.
  • The Range add-on, with lanes, classes and bookings.
  • The Enterprise plan, so the rate limit is 600 requests per minute.

You get an owner login for the back office, so you can create keys, set up webhook endpoints and watch your orders arrive at the register. To request a sandbox shop, email hello@ironregister.com.

Data that keeps moving

The sandbox isn't a frozen snapshot:

  • Daily. New activity is generated every day: counter sales, voids, returns, receivings, counts, new and updated customers, price changes and range bookings. Your updated_since syncs and webhooks see realistic traffic, and inventory.changed, sale.completed and the rest fire as they would in a real shop.
  • Weekly, on Sundays (US Eastern). The dataset is rebuilt from scratch. Your owner login, API keys and webhook endpoints are kept, but everything else is replaced, including what you created through the API. Record ids change, so don't hard-code them.

BigCommerce

Sandbox shops aren't connected to a BigCommerce store. To test the storefront side of a flow (orders placed online, stock pushed to BigCommerce), connect your own BigCommerce sandbox or trial store from the sandbox back office under Settings → BigCommerce.

Differences from live

  • No real payments. API orders use the external tender, just as on live.
  • Federal forms can be filled in. The back office lets you complete 4473 workflows on held firearm orders, but they're test records.