> ## Documentation Index
> Fetch the complete documentation index at: https://developer.kalixo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List sandbox test products

> Sandbox only. Returns the Kalixo Test products with their expected outcome and a `sampleOrderLine` you can send to `POST /orders` as-is. The same products appear in `GET /catalog/products` with brand **Kalixo Test** and `isSandboxProduct: true`. On the production API this endpoint returns `404`.



## OpenAPI

````yaml /openapi.json get /sandbox/scenarios
openapi: 3.1.0
info:
  title: Kalixo Distribution API
  version: 2.4.0
  description: >-
    The Kalixo Distribution API lets partners browse their product catalog,
    place and track digital gift-card orders (single or bulk), and monitor their
    wallet balance. All v2 ordering is asynchronous: place an order, then poll
    it until the codes are delivered.


    Every response carries an `X-Request-Id` header; include it when you contact
    support. Responses after authentication also carry `X-RateLimit-Limit`,
    `X-RateLimit-Remaining` and `X-RateLimit-Reset`.
  contact:
    name: Kalixo Integrations
    email: integrations@kalixo.io
servers:
  - url: https://api.kalixo.io/v2
    description: Production
  - url: https://sandbox.kalixo.io/v2
    description: Sandbox
security:
  - apiKey: []
tags:
  - name: Ping
    description: >-
      Verify API connectivity once your API key is issued and your IP is
      whitelisted.
  - name: Catalog
    description: >-
      Browse the products available in your catalog, including pricing, your
      discount amount and percentage, and open-denomination ranges.
  - name: Orders
    description: >-
      Place orders and poll them until codes are delivered. Single and bulk
      orders share the same asynchronous lifecycle.
  - name: Wallet
    description: Check your current wallet balances per currency.
  - name: Sandbox
    description: >-
      Sandbox-only helpers: the Kalixo Test products and their expected
      outcomes.
paths:
  /sandbox/scenarios:
    get:
      tags:
        - Sandbox
      summary: List sandbox test products
      description: >-
        Sandbox only. Returns the Kalixo Test products with their expected
        outcome and a `sampleOrderLine` you can send to `POST /orders` as-is.
        The same products appear in `GET /catalog/products` with brand **Kalixo
        Test** and `isSandboxProduct: true`. On the production API this endpoint
        returns `404`.
      operationId: listSandboxScenarios
      responses:
        '200':
          description: Kalixo Test products and expected outcomes.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SandboxScenarioList'
              examples:
                scenarios:
                  $ref: '#/components/examples/SandboxScenarios'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/SandboxOnly'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      servers:
        - url: https://sandbox.kalixo.io/v2
          description: Sandbox
components:
  headers:
    X-Request-Id:
      description: >-
        Unique ID of the request. Include it when you contact support. If you
        send your own `X-Request-Id` (8 to 64 letters, digits, `-` or `_`),
        Kalixo echoes it back.
      schema:
        type: string
        example: 3f2c1b9e-8d7a-4c6b-9e5f-1a2b3c4d5e6f
    X-RateLimit-Limit:
      description: Maximum requests allowed in the current 60-second window.
      schema:
        type: integer
        example: 60
    X-RateLimit-Remaining:
      description: Requests remaining in the current window.
      schema:
        type: integer
        example: 59
    X-RateLimit-Reset:
      description: Unix timestamp (seconds) when the current window resets.
      schema:
        type: integer
        example: 1717315200
    Retry-After:
      description: Seconds to wait before retrying (429 responses only).
      schema:
        type: integer
        example: 30
  schemas:
    SandboxScenarioList:
      type: object
      properties:
        products:
          type: array
          items:
            $ref: '#/components/schemas/SandboxScenario'
        note:
          type: string
          example: >-
            Kalixo Test products appear in GET /v2/catalog/products alongside
            your assigned catalog. All sandbox orders return SANDBOX-* test
            codes only.
    SandboxScenario:
      type: object
      properties:
        productCode:
          type: string
          description: Order with this productCode in the sandbox.
          example: '10999000412573'
        name:
          type: string
          example: Kalixo Test - Success (Fixed)
        price:
          type: integer
          description: Price in minor units.
          example: 499
        currencyCode:
          type: string
          example: GBP
        denominationType:
          $ref: '#/components/schemas/DenominationType'
        isSandboxProduct:
          type: boolean
          example: true
        expectedOutcome:
          type: string
          description: What the order does in the sandbox.
          example: completed with SANDBOX-* test code(s)
        sampleOrderLine:
          $ref: '#/components/schemas/OrderLine'
    Error:
      type: object
      description: >-
        Standard error response. See the Errors concept page for the complete
        message catalogue.
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
          example: 400
        error:
          type: string
          description: >-
            Short label for the status (for example `Bad Request`, `Not Found`).
            Omitted on some `500` responses.
          example: Bad Request
        message:
          type: string
          description: Human-readable explanation. May include the productCode you sent.
          example: 'Product 10020000213575 price mismatch: expected 10000'
    DenominationType:
      type: string
      enum:
        - fixed
        - open
      description: >-
        `fixed` products have a set price; `open` products accept any amount
        within a range.
    OrderLine:
      type: object
      required:
        - productCode
        - quantity
      properties:
        productCode:
          type: string
          description: The catalog product code.
          example: '10020000213575'
        price:
          type: integer
          description: >-
            Expected unit price in minor units. For fixed products this must
            match the catalog price; for open-denomination products this is the
            chosen amount within the allowed range.
          example: 10000
        quantity:
          type: integer
          minimum: 1
          example: 1
        currency:
          type: string
          description: Optional line currency. Defaults to the order-level currency.
          example: GBP
        sku:
          type: string
          description: >-
            Optional market SKU (`{CC}-{LL}-{productCode}`) from the catalog
            row. Its country prefix is used when `country` is omitted.
          example: GB-EN-10020000213575
        country:
          type: string
          description: >-
            ISO country code of the market to fulfil: the `countryCode` of the
            catalog row you are selling. Required when the product's
            `availableCountries` has more than one entry and `sku` does not
            carry the country. Must be one of `availableCountries`. Safe to send
            for every line.
          example: DE
  examples:
    SandboxScenarios:
      summary: Kalixo Test products (example values)
      description: >-
        productCodes differ per environment; call the endpoint for yours. Each
        scenario also exists in USD (US) and in EUR for every euro-area country.
      value:
        products:
          - productCode: '10999000412573'
            name: Kalixo Test - Success (Fixed)
            price: 499
            currencyCode: GBP
            denominationType: fixed
            isSandboxProduct: true
            expectedOutcome: completed with SANDBOX-* test code(s)
            sampleOrderLine:
              productCode: '10999000412573'
              quantity: 1
              price: 499
          - productCode: '10999000412581'
            name: Kalixo Test - Success (Open)
            price: 1000
            currencyCode: GBP
            denominationType: open
            isSandboxProduct: true
            expectedOutcome: completed - send line price for open denomination
            sampleOrderLine:
              productCode: '10999000412581'
              quantity: 1
              price: 1000
          - productCode: '10999000412599'
            name: Kalixo Test - Async Failure
            price: 499
            currencyCode: GBP
            denominationType: fixed
            isSandboxProduct: true
            expectedOutcome: failed (no codes)
            sampleOrderLine:
              productCode: '10999000412599'
              quantity: 1
              price: 499
          - productCode: '10999000412607'
            name: Kalixo Test - Partial Completion
            price: 499
            currencyCode: GBP
            denominationType: fixed
            isSandboxProduct: true
            expectedOutcome: partially_completed when qty ≥ 2 (odd units succeed)
            sampleOrderLine:
              productCode: '10999000412607'
              quantity: 1
              price: 499
          - productCode: '10999000412615'
            name: Kalixo Test - Slow Processing
            price: 499
            currencyCode: GBP
            denominationType: fixed
            isSandboxProduct: true
            expectedOutcome: processing ~10s then completed
            sampleOrderLine:
              productCode: '10999000412615'
              quantity: 1
              price: 499
        note: >-
          Kalixo Test products appear in GET /v2/catalog/products alongside your
          assigned catalog. All sandbox orders return SANDBOX-* test codes only.
    ErrorMissingApiKey:
      summary: Missing API key
      value:
        statusCode: 401
        error: Unauthorized
        message: Missing API key
    ErrorInvalidApiKey:
      summary: Invalid API key
      value:
        statusCode: 401
        error: Unauthorized
        message: Invalid API key
    ErrorSandboxOnly:
      summary: Sandbox only
      value:
        statusCode: 404
        error: Not Found
        message: Sandbox scenarios are not available on the production API
    ErrorRateLimit:
      summary: Rate limit exceeded
      value:
        statusCode: 429
        error: Too Many Requests
        message: Rate limit exceeded. Retry after 30s.
    ErrorInternalServerError:
      summary: Unexpected server error
      value:
        statusCode: 500
        message: Internal server error
  responses:
    Unauthorized:
      description: Missing or invalid `x-api-key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missingApiKey:
              $ref: '#/components/examples/ErrorMissingApiKey'
            invalidApiKey:
              $ref: '#/components/examples/ErrorInvalidApiKey'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
    SandboxOnly:
      description: Called on the production API. Sandbox helpers exist on the sandbox only.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            sandboxOnly:
              $ref: '#/components/examples/ErrorSandboxOnly'
    TooManyRequests:
      description: Rate limit exceeded. Wait `Retry-After` seconds, then retry.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            rateLimit:
              $ref: '#/components/examples/ErrorRateLimit'
    InternalServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            internalServerError:
              $ref: '#/components/examples/ErrorInternalServerError'
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your Kalixo API key. Send it in the `x-api-key` header on every request.
      x-default: kal_live_xxxxxxxxxxxxxxxxxxxxxxxx

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.