JouloDocs

List the sandbox helpers and test values

Sandbox only: send it to https://api-staging.joulo.nl (pick the Sandbox server). Returns the helper routes, the fixture states and the test values that pick an outcome.

GET
/sandbox/v1
AuthorizationBearer <token>

Partner API key, sent as Authorization: Bearer <key>. Production keys start with jpk_live_ and work only on https://api.joulo.nl. Sandbox keys start with jpk_test_ and work only on https://api-staging.joulo.nl. Sandbox keys minted before September 2026 also start with jpk_live_. A key used on the wrong host returns 401 with a detail. A key is bound to one partner and reaches only the Partner API routes. Any other route returns 404 when it does not exist. A route that needs a scope the key lacks, such as GET /sessions, returns 403 with error: Insufficient scope and a required_scope. Every other route returns 403 with error: partner_api_key_scope. Mint and revoke keys in the partner portal. A partner has one active key at a time.

In: header

Response Body

curl -X GET "https://api.joulo.nl/functions/v1/api/sandbox/v1"
{
  "environment": "sandbox",
  "routes": [
    "string"
  ],
  "fixture_states": [
    "string"
  ],
  "test_values": {},
  "ean_suffixes": {}
}
{
  "error": "Missing or invalid API token"
}
{
  "error": "string",
  "detail": "string",
  "step": "string",
  "reason": "string",
  "draft_status": "string"
}