API docs
Sandbox
The sandbox is a separate Black Beach POS 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.blackbeachpos.com/api/v1 |
| Back office | https://sandbox.blackbeachpos.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 candle and home-goods shop with two locations.
- A catalog with products stocked by quantity, by lot (with expiry dates) and by serial number.
- Customers, and weeks of sales history.
- 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@madfishsolutions.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, lot-tracked sales and price changes. Your
updated_sincesyncs and webhooks see realistic traffic, andinventory.changed,sale.completedand 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
externaltender, just as on live. - No real email. Receipts and alerts from the sandbox are logged, not sent.
