Lokki
Lokki External API

The partner-facing read-only Lokki API — seven GET operations over rental providers (stores), their store items with date-range pricing and stock, and the two-level verticale / category taxonomy. Documented publicly at docs.getlokki.com with an OpenAPI 3.1 specification; calls require an environment-scoped API key issued by a Lokki representative.
Documentation GitHub OpenAPI
OpenAPI Specification

{
  "openapi": "3.1.0",
  "info": {
    "title": "Lokki API",
    "description": "API documentation for Lokki, a rental management application.",
    "license": {
      "name": "MIT"
    },
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://staging.api.eu-west-3.lokki.rent"
    },
    {
      "url": "https://prod.api.eu-west-3.getlokki.com"
    }
  ],
  "security": [
    {
      "x-access-token": []
    }
  ],
  "paths": {
    "/v2/external/verticales": {
      "get": {
        "operationId": "external__getManyVerticales",
        "parameters": [
          {
            "name": "lang",
            "required": true,
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/VerticaleExternalDto"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v2/external/verticales/categories": {
      "get": {
        "operationId": "external__getManyCategories",
        "parameters": [
          {
            "name": "skip",
            "required": false,
            "in": "query",
            "description": "Number of documents to skip",
            "schema": {
              "minimum": 0,
              "default": 0,
              "type": "number"
            }
          },
          {
            "name": "limit",
            "required": false,
            "in": "query",
            "description": "Maximum number of documents to return",
            "schema": {
              "minimum": 0,
              "maximum": 100,
              "default": 100,
              "type": "number"
            }
          },
          {
            "name": "sort",
            "required": false,
            "in": "query",
            "schema": {
              "oneOf": [
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                {
                  "type": "string"
                }
              ]
            },
            "description": "Sort order for the results. Use '__asc' or '__desc' suffix to specify ascending or descending order respectively. Example: 'name__asc'"
          },
          {
            "name": "fields",
            "required": false,
            "in": "query",
            "schema": {
              "oneOf": [
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                {
                  "type": "string"
                }
              ]
            },
            "description": "Fields to include in the response"
          },
          {
            "name": "verticale.in",
            "required": false,
            "in": "query",
            "schema": {
              "oneOf": [
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                {
                  "type": "string"
                }
              ]
            },
            "description": "Filter entries that match any of the specified values"
          },
          {
            "name": "verticale.notIn",
            "required": false,
            "in": "query",
            "schema": {
              "oneOf": [
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                {
                  "type": "string"
                }
              ]
            },
            "description": "Filter entries that do not match any of the specified values"
          },
          {
            "name": "verticale.equals",
            "required": false,
            "in": "query",
            "description": "Filter entries that have a specific value",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "verticale.notEquals",
            "required": false,
            "in": "query",
            "description": "Filter entries that do not have a specific value",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "lang",
            "required": false,
            "in": "query",
            "description": "Language for localized content",
            "example": "fr",
            "schema": {
              "enum": [
                "fr",
                "en",
                "nl",
                "de",
                "it",
                "pt",
                "es",
                "pl"
              ],
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetManyCategoriesResponseDto"
                }
              }
            }
          }
        }
      }
    },
    "/v2/external/stores": {
      "get": {
        "operationId": "external__getManyStores",
        "parameters": [
          {
            "name": "skip",
            "required": false,
            "in": "query",
            "description": "Number of documents to skip",
            "schema": {
              "minimum": 0,
              "default": 0,
              "type": "number"
            }
          },
          {
            "name": "limit",
            "required": false,
            "in": "query",
            "description": "Maximum number of documents to return",
            "schema": {
              "minimum": 0,
              "maximum": 100,
              "default": 100,
              "type": "number"
            }
          },
          {
            "name": "sort",
            "required": false,
            "in": "query",
            "schema": {
              "oneOf": [
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                {
                  "type": "string"
                }
              ]
            },
            "description": "Sort order for the results. Use '__asc' or '__desc' suffix to specify ascending or descending order respectively. Example: 'name__asc'"
          },
          {
            "name": "fields",
            "required": false,
            "in": "query",
            "schema": {
              "oneOf": [
                {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                {
                  "type": "string"
                }
              ]
            },
            "description": "Fields to include in the response"
          },
          {
            "name": "verticale.in",
            "required": false,
            "in": "query",
            "schema": {
              "oneOf": [
                {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CompanyVerticale"
                  }
                },
                {
                  "type": "#/components/schemas/CompanyVerticale"
                }
              ]
            },
            "description": "Filter entries that match any of the specified values"
          },
          {
            "name": "verticale.notIn",
            "required": false,
            "in": "query",
            "schema": {
              "oneOf": [
                {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CompanyVerticale"
                  }
                },
                {
                  "type": "#/components/schemas/CompanyVerticale"
                }
              ]
            },
            "description": "Filter entries that do not match any of the specified values"
          },
          {
            "name": "verticale.equals",
            "required": false,
            "in": "query",
            "description": "Filter entries that have a specific value",
            "schema": {
              "$ref": "#/components/schemas/CompanyVerticale"
            }
          },
          {
            "name": "verticale.notEquals",
            "required": false,
            "in": "query",
            "description": "Filter entries that do not have a specific value",
            "schema": {
              "$ref": "#/components/schemas/CompanyVerticale"
            }
          },
          {
            "name": "position.radius",
            "required": false,
            "in": "query",
            "description": "Radius in kilometers (max 50km). Optional, but if provided, latitude and longitude must also be provided.",
            "schema": {
              "minimum": 0,
              "maximum": 50,
              "type": "number"
            }
          },
          {
            "name": "position.latitude",
            "required": false,
            "in": "query",
            "description": "Latitude of the position. Optional, but if provided, longitude and radius must also be provided.",
            "schema": {
              "minimum": -90,
              "maximum": 90,
              "type": "number"
            }
          },
          {
            "name": "position.longitude",
            "required": false,
            "in": "query",
            "description": "Longitude of the position. Optional, but if provided, latitude and radius must also be provided.",
            "schema": {
              "minimum": -180,
              "maximum": 180,
              "type": "number"
            }
          },
          {
            "name": "lang",
            "required": false,
            "in": "query",
            "description": "Language for localized content",
            "example": "fr",
            "schema": {
              "enum": [
                "fr",
                "en",
                "nl",
                "de",
                "it",
                "pt",
                "es",
                "pl"
              ],
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GetManyStoresResponseDto"
                }
              }
            }
          }
        }
      }
    },
    "/v2/external/stores/count": {
      "get": {
        "operationId": "external__getCountStores",
        "parameters": [
          {
            "name": "verticale.in",
            "required": false,
            "in": "query",
            "schema": {
              "oneOf": [
                {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CompanyVerticale"
                  }
                },
                {
                  "type": "#/components/schemas/CompanyVerticale"
                }
              ]
            },
            "description": "Filter entries that match any of the specified values"
          },
          {
            "name": "verticale.notIn",
            "required": false,
            "in": "query",
            "schema": {
              "oneOf": [
                {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CompanyVerticale"
                  }
                },
                {
                  "type": "#/components/schemas/CompanyVerticale"
                }
              ]
            },
            "description": "Filter entries that do not match any of the specified values"
          },
          {
            "name": "verticale.equals",
            "required": false,
            "in": "query",
            "description": "Filter entries that have a specific value",
            "schema": {
              "$ref": "#/components/schemas/CompanyVerticale"
            }
          },
          {
            "name": "verticale.notEquals",
            "required": false,
            "in": "query",
            "description": "Filter entries that do not have a specific value",
            "schema": {
              "$ref": "#/components/schemas/CompanyVerticale"
            }
          },
          {
            "name": "position.radius",
            "required": false,
            "in": "query",
            "description": "Radius in kilometers (max 50km). Optional, but if provided, latitude and longitude must also be provided.",
            "schema": {
              "minimum": 0,
              "maximum": 50,
              "type": "number"
            }
          },
          {
            "name": "position.latitude",
            "required": false,
            "in": "query",
            "description": "Latitude of the position. Optional, but if provided, longitude and radius must also be provided.",
            "schema": {
              "minimum": -90,
              "maximum": 90,
              "type": "number"
            }
          },
          {
            "name": "position.longitude",
            "required": false,
            "in": "query",
            "description": "Longitude of the position. Optional, but if provided, latitude and radius must also be provided.",
            "schema": {
              "minimum": -180,
              "maximum": 180,
              "type": "number"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CountStoresResponseDto"
                }
              }
            }
          }
        }
      }
    },
    "/v2/external/stores/{id}": {
      "get": {
        "operationId": "external__getOneStore",
        "parameters": [
          {
            "name": "id",
            "required": true,
            "in": "path",
            "description": "The unique ID or slug of the store",
            "example": "64b64c4f5f3c2a6d8e7f9a01",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "fields",
            "required": false,
            "in": "query",
            "description": "Fields to include in the response",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "lang",
            "required": false,
            "in": "query",
            "description": "Language for localized content",
            "example": "fr",
            "schema": {
              "default": "fr",
              "enum": [
                "fr",
                "en",
                "nl",
                "de",
                "it",
                "pt",
                "es",
                "pl"
              ],
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Deprecated_External_Store"
                }
              }
            }
          }
        }
      }
    },
    "/v2/external/stores/{slug}/items/{itemId}": {
      "get": {
        "operationId": "external__getOneStoreItem",
        "parameters": [
          {
            "name": "slug",
            "required": true,
            "in": "path",
            "description": "The slug of the store",
            "example": "my-store-slug",
            "schema": {
              "pattern": "/^[a-z0-9-]+$/",
              "type": "string"
            }
          },
          {
            "name": "itemId",
            "required": true,
            "in": "path",
            "description": "The ID of the item",
            "example": "item-12345",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "ids",
            "required": false,
            "in": "query",
            "description": "Item IDs to retrieve",
            "example": [
              "1",
              "2",
              "3"
            ],
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "lang",
            "required": true,
            "in": "query",
            "description": "Language for localized content",
            "example": "fr",
            "schema": {
              "default": "fr",
              "enum": [
                "fr",
                "en",
                "nl",
                "de",
                "it",
                "pt",
                "es",
                "pl"
              ],
              "type": "string"
            }
          },
          {
            "name": "preview",
            "required": false,
            "in": "query",
            "description": "If true, include unpublished stores (for preview mode)",
            "example": false,
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "name": "from",
            "required": false,
            "in": "query",
            "description": "Start date for filtering items (optional)",
            "example": "2025-09-26T10:00:00.000Z",
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "name": "to",
            "required": false,
            "in": "query",
            "description": "End date for filtering items (optional)",
            "example": "2025-10-31T14:30:00.000Z",
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "name": "verticale",
            "required": false,
            "in": "query",
            "description": "The large category of the item (e.g., BIKE, CAR, BOAT, etc.)",
            "example": "BIKE",
            "schema": {
              "enum": [
                "BIKE",
                "ELECTRIC_BIKE",
                "MOPED",
                "MOTORCYCLE",
                "CAR",
                "SCOOTER",
                "SKI",
                "CLIMBING",
                "SNOWSHOES",
                "SURF",
                "PADDLE",
                "CANOE_KAYAK",
                "BOAT",
                "EVENT",
                "MOTOCULTURE",
                "TOOLING"
              ],
              "type": "string"
            }
          },
          {
            "name": "verticaleCategoryIds",
            "required": false,
            "in": "query",
            "description": "The precise category of the item (e.g., Mountain Bike, Road Bike, etc.)",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "sortBy",
            "required": false,
            "in": "query",
            "description": "Sort by",
            "example": "price_asc",
            "schema": {
              "enum": [
                "relevance",
                "price_asc",
                "price_desc"
              ],
              "type": "string"
            }
          },
          {
            "name": "limit",
            "required": false,
            "in": "query",
            "description": "Limit of items to retrieve",
            "example": 10,
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "skip",
            "required": false,
            "in": "query",
            "description": "Skip of items to retrieve",
            "example": 0,
            "schema": {
              "default": 0,
              "type": "number"
            }
          },
          {
            "name": "fields",
            "required": false,
            "in": "query",
            "description": "Fields to include in the response",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StoreItemDto"
                }
              }
            }
          }
        }
      }
    },
    "/v2/external/stores/{slug}/items": {
      "get": {
        "operationId": "external__getManyStoreItems",
        "parameters": [
          {
            "name": "slug",
            "required": true,
            "in": "path",
            "description": "The slug of the store",
            "example": "my-store-slug",
            "schema": {
              "pattern": "/^[a-z0-9-]+$/",
              "type": "string"
            }
          },
          {
            "name": "ids",
            "required": false,
            "in": "query",
            "description": "Item IDs to retrieve",
            "example": [
              "1",
              "2",
              "3"
            ],
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "lang",
            "required": true,
            "in": "query",
            "description": "Language for localized content",
            "example": "fr",
            "schema": {
              "default": "fr",
              "enum": [
                "fr",
                "en",
                "nl",
                "de",
                "it",
                "pt",
                "es",
                "pl"
              ],
              "type": "string"
            }
          },
          {
            "name": "preview",
            "required": false,
            "in": "query",
            "description": "If true, include unpublished stores (for preview mode)",
            "example": false,
            "schema": {
              "default": false,
              "type": "boolean"
            }
          },
          {
            "name": "from",
            "required": false,
            "in": "query",
            "description": "Start date for filtering items (optional)",
            "example": "2025-09-26T10:00:00.000Z",
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "name": "to",
            "required": false,
            "in": "query",
            "description": "End date for filtering items (optional)",
            "example": "2025-10-31T14:30:00.000Z",
            "schema": {
              "format": "date-time",
              "type": "string"
            }
          },
          {
            "name": "verticale",
            "required": false,
            "in": "query",
            "description": "The large category of the item (e.g., BIKE, CAR, BOAT, etc.)",
            "example": "BIKE",
            "schema": {
              "enum": [
                "BIKE",
                "ELECTRIC_BIKE",
                "MOPED",
                "MOTORCYCLE",
                "CAR",
                "SCOOTER",
                "SKI",
                "CLIMBING",
                "SNOWSHOES",
                "SURF",
                "PADDLE",
                "CANOE_KAYAK",
                "BOAT",
                "EVENT",
                "MOTOCULTURE",
                "TOOLING"
              ],
              "type": "string"
            }
          },
          {
            "name": "verticaleCategoryIds",
            "required": false,
            "in": "query",
            "description": "The precise category of the item (e.g., Mountain Bike, Road Bike, etc.)",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "sortBy",
            "required": false,
            "in": "query",
            "description": "Sort by",
            "example": "price_asc",
            "schema": {
              "enum": [
                "relevance",
                "price_asc",
                "price_desc"
              ],
              "type": "string"
            }
          },
          {
            "name": "limit",
            "required": false,
            "in": "query",
            "description": "Limit of items to retrieve",
            "example": 10,
            "schema": {
              "type": "number"
            }
          },
          {
            "name": "skip",
            "required": false,
            "in": "query",
            "description": "Skip of items to retrieve",
            "example": 0,
            "schema": {
              "default": 0,
              "type": "number"
            }
          },
          {
            "name": "fields",
            "required": false,
            "in": "query",
            "description": "Fields to include in the response",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/StoreItemDto"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "x-access-token": {
        "type": "apiKey",
        "in": "header",
        "name": "x-access-token"
      }
    },
    "schemas": {
      "CompanyVerticale": {
        "type": "string",
        "enum": [
          "BIKE",
          "ELECTRIC_BIKE",
          "MOPED",
          "MOTORCYCLE",
          "CAR",
          "SCOOTER",
          "SKI",
          "CLIMBING",
          "SNOWSHOES",
          "SURF",
          "PADDLE",
          "CANOE_KAYAK",
          "BOAT",
          "EVENT",
          "MOTOCULTURE",
          "TOOLING"
        ]
      },
      "VerticaleExternalDto": {
        "type": "object",
        "properties": {
          "id": {
            "enum": [
              "BIKE",
              "ELECTRIC_BIKE",
              "MOPED",
              "MOTORCYCLE",
              "CAR",
              "SCOOTER",
              "SKI",
              "CLIMBING",
              "SNOWSHOES",
              "SURF",
              "PADDLE",
              "CANOE_KAYAK",
              "BOAT",
              "EVENT",
              "MOTOCULTURE",
              "TOOLING"
            ],
            "type": "string",
            "description": "Unique identifier for the verticale",
            "example": "BIKE"
          },
          "infos": {
            "description": "Descriptive information about the verticale",
            "allOf": [
              {
                "$ref": "#/components/schemas/VerticaleExternalInfos"
              }
            ]
          }
        },
        "required": [
          "id",
          "infos"
        ]
      },
      "GetManyCategoriesResponseDto": {
        "type": "object",
        "properties": {
          "total": {
            "type": "number",
            "description": "Total number of categories matching the query",
            "minimum": 0,
            "example": 10
          },
          "docs": {
            "description": "List of categories matching the query",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CategoryExternalDto"
            }
          }
        },
        "required": [
          "total",
          "docs"
        ]
      },
      "GetManyStoresResponseDto": {
        "type": "object",
        "properties": {
          "total": {
            "type": "number",
            "description": "Total number of documents matching the query",
            "minimum": 0,
            "example": 150
          },
          "docs": {
            "description": "List of stores matching the query",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Deprecated_External_Store"
            }
          }
        },
        "required": [
          "total",
          "docs"
        ]
      },
      "CountStoresResponseDto": {
        "type": "object",
        "properties": {
          "total": {
            "type": "number",
            "description": "Total number of stores matching the query",
            "minimum": 0,
            "example": 42
          }
        },
        "required": [
          "total"
        ]
      },
      "Deprecated_External_Store": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the booking store - MongoDB ObjectId",
            "example": "64b64c4f5f3c2a6d8e7f9b0a"
          },
          "slug": {
            "type": "string",
            "description": "Unique identifier for the store. Used for URL paths (e.g., https://www.lokki.rent/loueur/my-store)",
            "example": "my-store"
          },
          "rentalPointSlug": {
            "type": "string",
            "description": "Slug of the rental point to get details for. If not provided, main store location is used.",
            "example": "my-rental-point"
          },
          "profile": {
            "description": "Store general profile information (name, description, verticales)",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreProfile"
              }
            ]
          },
          "localization": {
            "description": "Store localization information (current, default, available languages)",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreLocalization"
              }
            ]
          },
          "contact": {
            "description": "Store contact information (email, phone, website, social media, etc.)",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreContact"
              }
            ]
          },
          "branding": {
            "description": "Store branding information (banners, colors, etc.)",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreBranding"
              }
            ]
          },
          "geo": {
            "description": "Store geographical information (main and secondary locations)",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreGeo"
              }
            ]
          },
          "modules": {
            "description": "Store modules settings (delivery, online payment, insurance, etc.)",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreModules"
              }
            ]
          },
          "reviews": {
            "description": "Store reviews from external platforms (e.g., Google Reviews)",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreReviews"
              }
            ]
          },
          "temporal": {
            "description": "Store temporal settings (opening hours, timezone, etc.)",
            "allOf": [
              {
                "$ref": "#/components/schemas/StoreTemporal"
              }
            ]
          },
          "pricing": {
            "description": "Store pricing settings (currency, tax, discounts, etc.)",
            "allOf": [
              {
                "$ref": "#/components/schemas/StorePricing"
              }
            ]
          },
          "booking": {
            "description": "Booking settings",
            "allOf": [
              {
            

# --- truncated at 32 KB (110 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/lokki/refs/heads/main/openapi/lokki-external-api-openapi.json
Lokki External API

Documentation

Specifications

Other Resources

OpenAPI Specification
