Solia Direct DocsControl Plane
⌘K

API ReferenceReference

Sandbox endpoints

Exact request and response contracts for the sandbox endpoints, generated from the enforced Partner API contract.

Machine-readable OpenAPI description

Endpoints in this group

GET/v1/sandbox/order-fixturesList synthetic order-request fixtures
GET/v1/sandbox/scenariosList deterministic sandbox scenarios
POST/v1/sandbox/orders/{orderId}/simulateAdvance a synthetic sandbox order through a scenario

Base path: /api/public/partner/v1. Every response carries request_id; every failure uses the standard error envelope documented under Errors.

GET/v1/sandbox/order-fixtures

List synthetic order-request fixtures

Clearly synthetic request templates for the minimal, provider, patient and ask-at-order-entry contracts. Never real data.

Authentication & scope

  • Authentication: Authorization: Bearer <API key>. The key is bound to one laboratory, one API client and one environment.
  • No resource scope is required beyond a valid, active key.

Responses

  • 200 — Synthetic fixtures.
json
{
  "data": [
    {}
  ],
  "request_id": "string",
  "cursor": "string"
}

GET/v1/sandbox/scenarios

List deterministic sandbox scenarios

Authentication & scope

  • Authentication: Authorization: Bearer <API key>. The key is bound to one laboratory, one API client and one environment.
  • No resource scope is required beyond a valid, active key.

Responses

  • 200 — Available scenarios.
json
{
  "data": [
    {
      "scenario": "happy_path",
      "steps": 1,
      "events": [
        "order.created"
      ]
    }
  ],
  "request_id": "string",
  "cursor": "string"
}

POST/v1/sandbox/orders/{orderId}/simulate

Advance a synthetic sandbox order through a scenario

Sandbox only. A production key or a non-synthetic order is refused.

Authentication & scope

  • Authentication: Authorization: Bearer <API key>. The key is bound to one laboratory, one API client and one environment.
  • Required scope: orders:write. A key without it is refused with 403 forbidden.

Path parameters

  • orderId (required) — string (uuid). Sandbox order identifier.

Request body

Required body fields: scenario.

json
{
  "scenario": "happy_path"
}

Responses

  • 200 — Applied steps.
  • 422 — Simulation is not permitted for this key or order.
json
{
  "data": {
    "order_id": "8f14e45f-ceea-4c2b-9b3f-2a1d0c7b6a11",
    "scenario": "string",
    "events_emitted": 1
  },
  "request_id": "string",
  "cursor": "string"
}