Skip to main content
GET
/
v2
/
external
/
stores
cURL
curl --request GET \
  --url https://staging.api.eu-west-3.lokki.rent/v2/external/stores \
  --header 'x-access-token: <api-key>'
{
  "total": 150,
  "docs": [
    {
      "id": "64b64c4f5f3c2a6d8e7f9b0a",
      "slug": "my-store",
      "profile": {
        "name": "Henri Corp",
        "description": "Location de vélos entre particuliers. Louez un vélo près de chez vous, où que vous soyez en France.",
        "verticales": [
          "BIKE",
          "SCOOTER"
        ]
      },
      "localization": {
        "current": "fr",
        "default": "fr",
        "available": [
          "fr",
          "en"
        ]
      },
      "contact": {
        "socialMedia": {
          "facebook": "https://www.facebook.com/henricorp",
          "twitter": "https://www.twitter.com/henricorp",
          "instagram": "https://www.instagram.com/henricorp",
          "linkedIn": "https://www.linkedin.com/company/henricorp",
          "tiktok": "https://www.tiktok.com/@henricorp"
        }
      },
      "branding": {
        "logoURL": "<string>",
        "banners": {
          "urls": [
            "<string>"
          ],
          "scrollTime": 5
        }
      },
      "geo": {
        "location": {
          "id": "64b64c4f5f3c2a6d8e7f9b0b",
          "name": "Point de retrait - Gare de Lyon",
          "slug": "my-location",
          "address": "4 Rue du Commandant Rivière, 75008 Paris, France",
          "placeId": "ChIJLU7jZClu5kcR4PcOOO6p3I0",
          "components": {
            "streetNumber": "4",
            "street": "Rue du Commandant Rivière",
            "postalCode": "75008",
            "city": "Paris",
            "administrativeAreaLevel1": "Île-de-France",
            "administrativeAreaLevel2": "Paris",
            "country": "France"
          },
          "point": {
            "lat": 48.8728361,
            "lng": 2.3094988
          }
        },
        "locations": [
          {
            "id": "64b64c4f5f3c2a6d8e7f9b0b",
            "name": "Point de retrait - Gare de Lyon",
            "slug": "my-location",
            "address": "4 Rue du Commandant Rivière, 75008 Paris, France",
            "placeId": "ChIJLU7jZClu5kcR4PcOOO6p3I0",
            "components": {
              "streetNumber": "4",
              "street": "Rue du Commandant Rivière",
              "postalCode": "75008",
              "city": "Paris",
              "administrativeAreaLevel1": "Île-de-France",
              "administrativeAreaLevel2": "Paris",
              "country": "France"
            },
            "point": {
              "lat": 48.8728361,
              "lng": 2.3094988
            }
          }
        ]
      },
      "modules": {
        "delivery": {
          "enabled": true,
          "deliveryOnly": false,
          "ranges": [
            {
              "min": 0,
              "max": 5,
              "price": 10,
              "specificPrices": [
                {
                  "price": 5,
                  "cities": [
                    {
                      "cityName": "Paris",
                      "sublocalityName": "Batignolles",
                      "zipCode": "75017",
                      "placeId": "ChIJD7fiBh9u5kcRYJSMaMOCCwQ",
                      "hasMultiplePostcodeLocalities": false
                    }
                  ]
                }
              ]
            }
          ],
          "excludedCities": [
            {
              "cityName": "Paris",
              "sublocalityName": "Batignolles",
              "zipCode": "75017",
              "placeId": "ChIJD7fiBh9u5kcRYJSMaMOCCwQ",
              "hasMultiplePostcodeLocalities": false
            }
          ],
          "freeDelivery": {
            "activated": true,
            "type": "MINUTES",
            "value": 60
          }
        },
        "onlinePayment": {
          "enabled": true,
          "provider": "STRIPE"
        },
        "insurance": {
          "enabled": true,
          "provider": "TULIP",
          "details": {
            "provider": "TULIP",
            "status": "on_inclusion"
          }
        },
        "multipleLocations": {
          "enabled": true,
          "dropoffRule": "DIFFERENT"
        },
        "cancellation": {
          "enabled": true,
          "ranges": [
            {
              "hourThreshold": 48,
              "refundType": "PERCENTAGE",
              "refundAmount": 50
            }
          ]
        }
      },
      "reviews": {
        "google": {
          "rating": 4.5,
          "total": 120,
          "placeId": "ChIJLU7jZClu5kcR4PcOOO6p3I0",
          "reviews": [
            {
              "author": {
                "name": "John Doe",
                "profilePictureUrl": "https://example.com/profile.jpg"
              },
              "comment": "Great service and friendly staff!",
              "rating": 5,
              "publishTime": "2024-10-15T10:30:00.000Z"
            }
          ],
          "mapsUrl": "https://maps.google.com/?cid=1234567890123456789",
          "updatedAt": "2024-11-01T12:00:00.000Z"
        }
      },
      "temporal": {
        "timezone": "Europe/Paris",
        "schedule": {
          "openingHours": [
            {
              "id": "64b64c4f5f3c2a6d8e7f9b0c",
              "day": "1",
              "from": "09:00",
              "to": "18:00",
              "open": true
            }
          ],
          "openingHoursLowSeason": [
            {
              "id": "64b64c4f5f3c2a6d8e7f9b0c",
              "day": "1",
              "from": "09:00",
              "to": "18:00",
              "open": true
            }
          ],
          "lowSeasonRanges": [
            {
              "id": "64b64c4f5f3c2a6d8e7f9b0d",
              "from": "2024-12-01T00:00:00.000Z",
              "to": "2024-12-31T23:59:59.999Z"
            }
          ],
          "closedRanges": [
            {
              "id": "64b64c4f5f3c2a6d8e7f9b0d",
              "from": "2024-12-01T00:00:00.000Z",
              "to": "2024-12-31T23:59:59.999Z"
            }
          ]
        }
      },
      "pricing": {
        "currency": {
          "isoCode": "EUR",
          "symbol": "€"
        },
        "tax": {
          "type": "INCLUSIVE",
          "value": 20,
          "name": "TVA"
        },
        "discount": {
          "globalDiscounts": [
            {
              "percentage": "10.0",
              "from": "2024-12-01T00:00:00.000Z",
              "to": "2024-12-31T23:59:59.999Z",
              "applicableDate": "START_DATE"
            }
          ],
          "categoryDiscounts": [
            {
              "itemCategoryIds": [
                "<string>"
              ],
              "rules": [
                {
                  "discount": 123,
                  "discountType": "AMOUNT",
                  "rangeFrom": 123,
                  "rangeTo": 123,
                  "infiniteTo": true
                }
              ]
            }
          ]
        }
      },
      "booking": {
        "bookingType": {
          "lcd": true,
          "lld": true,
          "event": true
        },
        "instantBooking": {
          "lcd": true,
          "lld": true
        },
        "fixedDurations": {
          "enabled": true,
          "durations": [
            {
              "id": "64b64c4f5f3c2a6d8e7f9b0e",
              "minutes": 60,
              "hours": 1,
              "label": "1 hour"
            }
          ]
        },
        "rules": {
          "timeAnchors": {
            "startTimes": [
              {
                "hours": 9,
                "minutes": 30
              }
            ],
            "endTimes": [
              {
                "hours": 9,
                "minutes": 30
              }
            ]
          },
          "leadTime": {
            "minHours": 2
          },
          "duration": {
            "minHours": 1,
            "maxHours": 24
          }
        }
      },
      "name": "My Store",
      "logoURL": "https://bucket-prod.getlokki.com/****+/logo.png",
      "bannerURL": [
        "https://bucket-prod.getlokki.com/****+/banner1.png",
        "https://bucket-prod.getlokki.com/****+/banner2.png"
      ],
      "pageUrl": "https://www.lokki.rent/loueur/my-store?utm_source=partner&utm_medium=social&utm_campaign=spring-sale",
      "currency": {
        "isoName": "EUR",
        "symbol": "€"
      },
      "lat": 50.62925,
      "lng": 3.057256,
      "address": "1 Place du Général de Gaulle, 59000 Lille, France",
      "addressComponents": {
        "administrativeAreaLevel1": "Hauts-de-France",
        "administrativeAreaLevel2": "Nord",
        "city": "Lille",
        "country": "France",
        "placeId": "ChIJCSaqfIjVwkcRhvxuup4tznk",
        "postalCode": "59000",
        "street": "Place du Général de Gaulle",
        "streetNumber": "1"
      },
      "googleRating": 4.5,
      "googleReviewsNb": 120,
      "verticales": [
        "BIKE"
      ],
      "rentalPointSlug": "my-rental-point",
      "distance": 5
    }
  ]
}

Authorizations

x-access-token
string
header
required

Query Parameters

skip
number
default:0

Number of documents to skip

Required range: x >= 0
limit
number
default:100

Maximum number of documents to return

Required range: 0 <= x <= 100
sort

Sort order for the results. Use '__asc' or '__desc' suffix to specify ascending or descending order respectively. Example: 'name__asc'

fields

Fields to include in the response

verticale.equals
enum<string>

Filter entries that have a specific value

Available options:
BIKE,
ELECTRIC_BIKE,
MOPED,
MOTORCYCLE,
CAR,
SCOOTER,
SKI,
CLIMBING,
SNOWSHOES,
SURF,
PADDLE,
CANOE_KAYAK,
BOAT,
EVENT,
MOTOCULTURE,
TOOLING
verticale.notEquals
enum<string>

Filter entries that do not have a specific value

Available options:
BIKE,
ELECTRIC_BIKE,
MOPED,
MOTORCYCLE,
CAR,
SCOOTER,
SKI,
CLIMBING,
SNOWSHOES,
SURF,
PADDLE,
CANOE_KAYAK,
BOAT,
EVENT,
MOTOCULTURE,
TOOLING
verticale.in

Filter entries that match any of the specified values

Available options:
BIKE,
ELECTRIC_BIKE,
MOPED,
MOTORCYCLE,
CAR,
SCOOTER,
SKI,
CLIMBING,
SNOWSHOES,
SURF,
PADDLE,
CANOE_KAYAK,
BOAT,
EVENT,
MOTOCULTURE,
TOOLING
verticale.notIn

Filter entries that do not match any of the specified values

Available options:
BIKE,
ELECTRIC_BIKE,
MOPED,
MOTORCYCLE,
CAR,
SCOOTER,
SKI,
CLIMBING,
SNOWSHOES,
SURF,
PADDLE,
CANOE_KAYAK,
BOAT,
EVENT,
MOTOCULTURE,
TOOLING
position.radius
number

Radius in kilometers (max 50km). Optional, but if provided, latitude and longitude must also be provided.

Required range: 0 <= x <= 50
position.latitude
number

Latitude of the position. Optional, but if provided, longitude and radius must also be provided.

Required range: -90 <= x <= 90
position.longitude
number

Longitude of the position. Optional, but if provided, latitude and radius must also be provided.

Required range: -180 <= x <= 180

Response

200 - application/json
total
number
required

Total number of documents matching the query

Required range: x >= 0
Example:

150

docs
object[]
required

List of stores matching the query