Sandbox
Test your integration end-to-end without touching live data. Sandbox kits — created by placing orders with a sandbox API token — can be advanced to any lifecycle status or driven to named scenarios such as delivered, resulted, or rejected, firing the same webhooks a live kit would. You can also list sandbox kits, delete sandbox orders, and reset all sandbox data; these endpoints require a sandbox API token and return 403 otherwise.
Advance a sandbox kit to a status
Advances a mock kit to the given lifecycle status, firing the same webhooks a live kit would.
Run a named scenario on a sandbox kit
Jumps a mock kit straight to a named milestone — a convenience over
List sandbox kits
Returns every mock kit created under your sandbox orders. Create sandbox kits by placing orders through `POST /api/v1/create-order` with a sandbox API token, then drive them with `POST /api/v1/sandbox/kits/{kitID}/advance`. Requires a **sandbox API token** (`403` otherwise).
Delete a sandbox order
Deletes a sandbox order along with its mock kits, reports, and webhook history. To wipe all sandbox data at once, use `POST /api/v1/sandbox/reset`. Requires a **sandbox API token** (`403` otherwise).
Reset all sandbox data
Deletes every sandbox order, kit, report, and webhook record for your business, returning the sandbox to a clean state. Live data is never touched. Requires a **sandbox API token** (`403` otherwise).