Hakuna API

openapi: 3.1.0
info:
  title: Hakuna API
  version: '2026-10-24'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-24: 7 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Hakuna has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 3
    documentation: 4
    pages-with-code: 4
    pages-read: 4
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-24'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.hellohakuna.com/using-the-api/versioning.md
  - https://docs.hellohakuna.com/using-the-api/authentication.md
  - https://docs.hellohakuna.com/sharing-order-events/sharing-order-events-with-the-events-api.md
  - https://hakuna-api.redoc.ly
servers:
- url: https://api.hellohakuna.com
paths:
  /cart_checkout:
    post:
      operationId: post_cart_checkout
      tags:
      - Cart Checkout
      summary: Notifies Hakuna about successful checkout (Deprecated)
      x-source: https://hakuna-api.redoc.ly
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCartCheckoutRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCartCheckoutResponse'
      x-evidence:
        kind: documentation
  /cart_updates:
    post:
      operationId: post_cart_updates
      tags:
      - Cart Updates
      summary: Notifies Hakuna about cart updates (Deprecated)
      x-source: https://hakuna-api.redoc.ly
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCartUpdatesRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCartUpdatesResponse'
      x-evidence:
        kind: documentation
  /checkouts:
    post:
      operationId: post_checkouts
      tags:
      - Checkouts
      summary: Generate a link to the Hakuna Redirect checkout without customer data
      x-source: https://hakuna-api.redoc.ly
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCheckoutsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCheckoutsResponse'
      x-evidence:
        kind: documentation
  /events:
    post:
      operationId: post_events
      tags:
      - Events
      summary: Publish order related event
      x-source: https://hakuna-api.redoc.ly
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostEventsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostEventsResponse'
      x-evidence:
        kind: documentation
  /offers:
    post:
      operationId: post_offers
      tags:
      - Offers
      summary: Request an offer for a specific product or a product collection
      x-source: https://hakuna-api.redoc.ly
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostOffersRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostOffersResponse'
      x-evidence:
        kind: documentation
  /sandbox/events:
    post:
      operationId: post_sandbox_events
      tags:
      - Sandbox
      summary: POST /sandbox/events
      x-source: https://docs.hellohakuna.com/sharing-order-events/sharing-order-events-with-the-events-api.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSandboxEventsRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostSandboxEventsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST 'https://api.hellohakuna.com/sandbox/events'  -H 'Bearer: REDACTED_STRIPE_KEY'  -H 'Content-Type:\
          \ application/json'  -d '{\n  \"type\": \"order_placed\",\n  \"payload\": {\n    \"order_id\": \"ord-123\",\n    \"placed_at\": \"2022-02-20T00:00:00.000Z\"\
          ,\n    \"order_currency\": \"eur\",\n    \"customer\": {\n      \"first_name\": \"Max\",\n      \"last_name\": \"Mustermann\",\n   \
          \   \"email\": \"max.mustermann@"
  /{endpoint}:
    get:
      operationId: get_endpoint
      tags:
      - Api
      summary: GET /{endpoint}
      x-source: https://docs.hellohakuna.com/using-the-api/versioning.md
      parameters:
      - name: endpoint
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://api.hellohakuna.com/<ENDPOINT>  -H "Hakuna-Version: v2.0"

          ```'
components:
  schemas:
    PostCartCheckoutRequest:
      type: object
      properties:
        cart_id:
          type: string
        user_session_id:
          type: string
        order_id:
          type: string
      required:
      - cart_id
      - user_session_id
      - order_id
    PostCartCheckoutResponse:
      type: object
      properties:
        cart_id:
          type: string
        user_session_id:
          type: string
        order_id:
          type: string
    PostCartUpdatesRequest:
      type: object
      properties:
        cart_id:
          type: string
        user_session_id:
          type: string
        cart_currency:
          type: string
          description: Currency code (ISO 4217).
        line_items:
          type: array
          description: List of line item objects.
      required:
      - cart_id
      - user_session_id
      - cart_currency
      - line_items
    PostCartUpdatesResponse:
      type: object
      properties:
        cart_id:
          type: string
        user_session_id:
          type: string
        actions:
          type: array
    PostCheckoutsRequest:
      type: object
      properties:
        checkout_type:
          type: string
          description: 'Value: "redirect".'
        order_id:
          type: string
        placed_at:
          type: string
          description: ISO 8601 date‑time when the order was placed.
        order_currency:
          type: string
          description: Three‑letter currency code (ISO 4217).
        order_country:
          type: string
          description: Two‑letter country code (ISO 3166‑1 alpha‑2) in lower case.
        line_items:
          type: array
          description: A non‑empty list of line item objects.
      required:
      - checkout_type
      - order_id
      - placed_at
      - order_currency
      - line_items
    PostCheckoutsResponse:
      type: object
      properties:
        checkout_type:
          type: string
        order_id:
          type: string
        redirect_link:
          type: string
        available_plans:
          type: array
    PostEventsRequest:
      type: object
      properties:
        type:
          type: string
          description: A type of event.
        payload:
          type: object
          description: A payload of event.
      required:
      - type
      - payload
    PostEventsResponse:
      type: object
      properties:
        event_id:
          type: string
    PostOffersRequest:
      type: object
      properties:
        country:
          type: string
          description: Two‑letter country code (ISO 3166‑1 alpha‑2) in lower case.
        offer_for:
          type: string
          description: Specifies that the offer is requested for a specific product.
        product:
          type: object
          description: A product object containing id, brand, title, category and price.
        product_collection:
          type: object
          description: Product collection with insurance_item_id_resolution.
      required:
      - country
      - offer_for
      - product
    PostOffersResponse:
      type: object
      properties:
        offer_id:
          type: string
        premium:
          type: object
        payment_modality:
          type: string
        content:
          type: object
        insurance_details_document:
          type: object
        applicable_product_price_range:
          type: object
        insurance_item_id:
          type: string
    PostSandboxEventsRequest:
      type: object
      properties:
        type:
          type: string
        payload:
          type: object
          properties:
            order_id:
              type: string
            placed_at:
              type: string
              format: date-time
            order_currency:
              type: string
            customer:
              type: object
              properties:
                first_name:
                  type: string
                last_name:
                  type: string
                email:
                  type: string
            customer_billing_address:
              type: object
              properties:
                address_line_1:
                  type: string
                address_line_2:
                  type: string
                city:
                  type: string
                country:
                  type: string
                zip:
                  type: string
            line_items:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  quantity:
                    type: integer
                  price_amount:
                    type: integer
                  product_id:
                    type: string
                  product_title:
                    type: string
                  product_brand:
                    type: string
    PostSandboxEventsResponse:
      type: object
      properties:
        event_id:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Cart Checkout
- name: Cart Updates
- name: Checkouts
- name: Events
- name: Offers
- name: Sandbox