Lokki

Lokki Your Order Event API

The Your Order Event API from Lokki — 8 operation(s) for your order event.

GitHub OpenAPI

Operations 8

GET /v2/your-order-event/{slug}/{orderEventId} #
GET /v2/your-order-event/getSignedUrlOrderEvent/{orderEventId}/{documentId}/{scope} #
POST /v2/your-order-event/signDocument #
POST /v2/your-order-event/signDocumentState #
POST /v2/your-order-event/cancel-request/{orderEventId} #
POST /v2/your-order-event/cancel-auto/{orderEventId} #
POST /v2/your-order-event/checkout/stripe #
POST /v2/your-order-event/checkout/adyen #

Documentation

📖
Documentation
https://docs.getlokki.com/
📖
APIReference
https://docs.getlokki.com/api-reference/getting-started
📖
GettingStarted
https://docs.getlokki.com/api-reference/getting-started
📖
Authentication
https://docs.getlokki.com/api-reference/authentication
📖
Documentation
https://prod.api.eu-west-3.lokki.rent/v2/api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/lokki/refs/heads/main/openapi/lokki-your-order-event-api-openapi.yml

Other Resources

🔗
Deprecation
https://docs.getlokki.com/api-reference/stores/deprecations
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/lokki/refs/heads/main/data-model/lokki-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/lokki/refs/heads/main/errors/lokki-problem-types.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/lokki-your-order-event-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

lokki-your-order-event-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Lokki Your Order Event API
  description: The main API powering the Lokki Dashboard and Online Store
  version: '2.0'
  contact: {}
servers: []
security:
- x-access-token: []
tags:
- name: Your Order Event
paths:
  /v2/your-order-event/{slug}/{orderEventId}:
    get:
      operationId: getYourOrderEvent
      parameters:
      - name: orderEventId
        required: true
        in: path
        schema:
          type: string
      - name: slug
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YourOrderEventDto'
      tags:
      - Your Order Event
  /v2/your-order-event/getSignedUrlOrderEvent/{orderEventId}/{documentId}/{scope}:
    get:
      operationId: getSignedUrlYourOrderEvent
      parameters:
      - name: orderEventId
        required: true
        in: path
        schema:
          type: string
      - name: documentId
        required: true
        in: path
        schema:
          type: string
      - name: scope
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YourOrderSignUrlDto'
      tags:
      - Your Order Event
  /v2/your-order-event/signDocument:
    post:
      operationId: signDocumentOrderEvent
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignDocumentYourOrderEventDto'
      responses:
        '201':
          description: ''
      tags:
      - Your Order Event
  /v2/your-order-event/signDocumentState:
    post:
      operationId: signDocumentStateOrderEvent
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignDocumentYourOrderEventDto'
      responses:
        '201':
          description: ''
      tags:
      - Your Order Event
  /v2/your-order-event/cancel-request/{orderEventId}:
    post:
      operationId: orderEventCancelRequest
      parameters:
      - name: orderEventId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelOrderInfosDto'
      responses:
        '201':
          description: ''
      tags:
      - Your Order Event
  /v2/your-order-event/cancel-auto/{orderEventId}:
    post:
      operationId: orderEventCancelAuto
      parameters:
      - name: orderEventId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelOrderInfosDto'
      responses:
        '201':
          description: ''
      tags:
      - Your Order Event
  /v2/your-order-event/checkout/stripe:
    post:
      operationId: initiateYourOrderEventStripeCheckout
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitiateStripeCheckoutYourOrderEventDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnlineStoreStripeCheckoutResultDto'
      tags:
      - Your Order Event
  /v2/your-order-event/checkout/adyen:
    post:
      operationId: initiateYourOrderEventAdyenCheckout
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitiateCheckoutYourOrderEventAdyenDto'
      responses:
        '201':
          description: ''
      tags:
      - Your Order Event
components:
  schemas:
    YourOrderEventAction:
      type: object
      properties:
        type:
          type: string
          enum:
          - PAYMENT
          - NONE
          - DOCUMENT
          - DOCUMENT_STATE
        payment:
          $ref: '#/components/schemas/YourOrderEventPaymentAndBail'
        bail:
          $ref: '#/components/schemas/YourOrderEventPaymentAndBail'
        document:
          $ref: '#/components/schemas/YourOrderDocumentAction'
        documentState:
          $ref: '#/components/schemas/YourOrderDocumentState'
      required:
      - type
    OrderEventPricings:
      type: object
      properties:
        label:
          type: string
        amount:
          type: number
        initialAmount:
          type: number
        id:
          type: string
      required:
      - label
      - amount
      - initialAmount
      - id
    YourOrderEventPaymentAndBail:
      type: object
      properties:
        amount:
          type: number
        id:
          type: string
        disabled:
          type: boolean
        isError:
          type: boolean
      required:
      - amount
      - id
    OnlineStoreAdyenCheckoutDto:
      type: object
      properties:
        paymentMethod:
          type: object
        browserInfo:
          type: object
      required:
      - paymentMethod
      - browserInfo
    SignDocumentYourOrderEventDto:
      type: object
      properties:
        orderEventId:
          type: string
        documentId:
          type: string
        lang:
          enum:
          - fr
          - en
          - es
          - pt
          - it
          - pl
          - de
          - nl
          type: string
      required:
      - orderEventId
      - documentId
      - lang
    OrderEventPerson:
      type: object
      properties:
        name:
          type: string
        pricing:
          type: string
        infos:
          type: object
        categoryItems:
          type: object
      required:
      - name
      - pricing
      - infos
      - categoryItems
    YourOrderDocument:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        scope:
          type: string
          enum:
          - DOCUMENT
          - DOCUMENT_STATE
          - PAYMENT
          - NONE
      required:
      - id
      - name
      - scope
    InitiateCheckoutYourOrderEventAdyenDto:
      type: object
      properties:
        orderEventId:
          type: string
        scope:
          type: string
          enum:
          - PAYMENT
          - BAIL
        linkId:
          type: string
        companyId:
          type: string
        adyenInfo:
          $ref: '#/components/schemas/OnlineStoreAdyenCheckoutDto'
      required:
      - orderEventId
      - scope
      - linkId
      - companyId
      - adyenInfo
    YourOrderOrderEventInfo:
      type: object
      properties:
        id:
          type: string
        isCanceled:
          type: boolean
        isRequest:
          type: boolean
        experienceName:
          $ref: '#/components/schemas/LocalizedContent'
        startDate:
          format: date-time
          type: string
        endDate:
          format: date-time
          type: string
        products:
          type: array
          items:
            $ref: '#/components/schemas/OrderEventProduct'
        pricings:
          type: array
          items:
            $ref: '#/components/schemas/OrderEventPricings'
        personInfos:
          type: array
          items:
            $ref: '#/components/schemas/OrderEventPerson'
        totalTTC:
          type: number
        amountPaid:
          type: number
        amountBail:
          type: number
        documents:
          type: array
          items:
            $ref: '#/components/schemas/YourOrderDocument'
        stateDocuments:
          type: array
          items:
            $ref: '#/components/schemas/YourOrderEventStateDocumentFromOrderEvent'
        createdFrom:
          type: string
          enum:
          - DASHBOARD
          - QUICK_ORDER
          - ONLINE_STORE
          - RENTAL_PLACE_B2B
          - RENTAL_PLACE_LOKKI
          - BORNE
          - SKISET
          - SKIMIUM
          - UNKNOWN
          - TEST
          - ADMIN_IMPORT
      required:
      - id
      - isCanceled
      - isRequest
      - experienceName
      - startDate
      - endDate
      - products
      - pricings
      - personInfos
      - totalTTC
      - amountPaid
      - amountBail
      - documents
      - stateDocuments
      - createdFrom
    YourOrderDocumentAction:
      type: object
      properties:
        documentId:
          type: string
      required:
      - documentId
    YourOrderActionStateProduct:
      type: object
      properties:
        name:
          type: string
        serialNumber:
          type: string
        departureInfo:
          type: string
        arrivalInfo:
          type: string
        stateInspectionFields:
          type: array
          items:
            $ref: '#/components/schemas/DocumentStateInspectionField'
        departureFiles:
          type: array
          items:
            type: string
        arrivalFiles:
          type: array
          items:
            type: string
      required:
      - name
      - serialNumber
      - departureInfo
      - arrivalInfo
      - stateInspectionFields
      - departureFiles
      - arrivalFiles
    OrderEventSubProduct:
      type: object
      properties:
        id:
          type: string
        available:
          type: boolean
        serialNumber:
          type: string
        status:
          type: string
          enum:
          - WAITING
          - USED
          - ENDED
      required:
      - id
      - available
      - serialNumber
      - status
    OnlineStoreStripeCheckoutResultDto:
      type: object
      properties:
        paymentClientSecret:
          type: string
    CancelOrderInfosDto:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    YourOrderDocumentState:
      type: object
      properties:
        documentId:
          type: string
        name:
          type: string
        documentStateProducts:
          type: array
          items:
            $ref: '#/components/schemas/YourOrderActionStateProduct'
      required:
      - documentId
      - name
      - documentStateProducts
    YourOrderEventStateDocumentFromOrderEvent:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        scope:
          type: string
          enum:
          - DOCUMENT
          - DOCUMENT_STATE
          - PAYMENT
          - NONE
        status:
          type: string
          enum:
          - TO_GENERATE
          - GENERATED
          - PENDING
      required:
      - id
      - name
      - scope
      - status
    YourOrderEventDto:
      type: object
      properties:
        orderEvent:
          $ref: '#/components/schemas/YourOrderOrderEventInfo'
        action:
          $ref: '#/components/schemas/YourOrderEventAction'
      required:
      - orderEvent
      - action
    OrderEventProduct:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
          - SERVICE
          - PRODUCT
        name:
          type: string
        price:
          type: number
        vat:
          type: number
        productImage:
          type: array
          items:
            type: string
        nbSelected:
          type: number
        subProducts:
          type: array
          items:
            $ref: '#/components/schemas/OrderEventSubProduct'
      required:
      - id
      - type
      - name
      - price
      - vat
      - productImage
      - nbSelected
      - subProducts
    DocumentStateInspectionField:
      type: object
      properties:
        name:
          type: string
        departureInfo:
          type: string
        arrivalInfo:
          type: string
      required:
      - name
      - departureInfo
      - arrivalInfo
    LocalizedContent:
      type: object
      additionalProperties:
        type: string
    InitiateStripeCheckoutYourOrderEventDto:
      type: object
      properties:
        orderEventId:
          type: string
        paymentId:
          type: string
        bailId:
          type: string
        companyId:
          type: string
      required:
      - orderEventId
      - paymentId
      - bailId
      - companyId
    YourOrderSignUrlDto:
      type: object
      properties:
        url:
          type: string
      required:
      - url
  securitySchemes:
    x-access-token:
      scheme: bearer
      bearerFormat: JWT
      type: apiKey
      in: header
      name: x-access-token