Skip to content

Sandbox

A sandbox for trying calls is in development; until then, try the examples with a key of your own company.

Version v1.1, updated

On this page

A sandbox for trying calls without touching real data is in development. Until it exists, you can try the examples with a key of your own company.

What it will allow

In development. The sandbox will give you a separate company with sample data, and keys that work only there. Calls in the sandbox will never touch the data of your real company.

Try the examples today

  1. Create a key with read scopes only, named for the trial. See Create your first key.

  2. Run the read examples. A read never changes anything.

  3. For writes, create a second key with the write scopes you need.

  4. Work only on records you create for the trial, with names you recognise, such as a product with the SKU TRIAL-001.

  5. Revoke the trial keys when you are done.

Warning. Writes act on the real data of your company. An issued invoice takes a real number from your series and never changes again.

Undo what you tried

  • Archive a trial product with PATCH /v1/products/{id} and "status": "archived".

  • Cancel a trial order with POST /v1/orders/{id}/cancel.

  • Reverse a stock adjustment with an adjustment of the opposite quantity.

  • Correct an issued invoice in BIRP, with a credit note.

Issue a trial invoice only if you mean to keep it, since the API cannot undo an issue.

Related

  • first-key
  • first-request
  • scopes
  • test-key-not-supported