Skip to main content
GET
/
v2
/
external
/
stores
/
{id}
cURL
curl --request GET \
  --url https://staging.api.eu-west-3.lokki.rent/v2/external/stores/{id} \
  --header 'x-access-token: <api-key>'
{
  "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"
      },
      "canonicalComponents": {
        "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"
        },
        "canonicalComponents": {
          "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",
      "methods": {
        "card": true,
        "applePay": true,
        "googlePay": true,
        "ancvConnect": false,
        "sepa": false,
        "ideal": false,
        "bancontact": false,
        "giroPay": false,
        "p24": false,
        "blik": false,
        "multibanco": false,
        "eps": false
      }
    },
    "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
            }
          ]
        }
      ]
    },
    "showPricingTable": 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
      }
    }
  },
  "metadata": {
    "timestamps": {
      "createdAt": "2024-10-15T10:30:00.000Z"
    }
  },
  "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
}
Retrieve detailed information about a specific store using its unique identifier (ID) or slug.

Authorizations

​
x-access-token
string
header
required

Path Parameters

​
id
string
required

The unique ID or slug of the store

Query Parameters

​
fields
string[]

Fields to include in the response

​
lang
enum<string>
default:fr

Language for localized content

Available options:
fr,
en,
nl,
de,
it,
pt,
es,
pl

Response

200 - application/json
​
id
string
required

Unique identifier for the booking store - MongoDB ObjectId

Example:

"64b64c4f5f3c2a6d8e7f9b0a"

​
slug
string
required

Unique identifier for the store. Used for URL paths (e.g., https://www.lokki.rent/loueur/my-store)

Example:

"my-store"

​
profile
object
required

Store general profile information (name, description, verticales)

​
localization
object
required

Store localization information (current, default, available languages)

​
contact
object
required

Store contact information (email, phone, website, social media, etc.)

​
branding
object
required

Store branding information (banners, colors, etc.)

​
geo
object
required

Store geographical information (main and secondary locations)

​
modules
object
required

Store modules settings (delivery, online payment, insurance, etc.)

​
reviews
object
required

Store reviews from external platforms (e.g., Google Reviews)

​
temporal
object
required

Store temporal settings (opening hours, timezone, etc.)

​
pricing
object
required

Store pricing settings (currency, tax, discounts, etc.)

​
booking
object
required

Booking settings

​
metadata
object
required

Store technical metadata and timestamps

​
name
string
required
deprecated

Name of the store. Deprecated, use profile.name instead.

Example:

"My Store"

​
logoURL
string
required
deprecated

URL to the store logo image Deprecated, use branding.logoURL instead.

Example:

"https://bucket-prod.getlokki.com/****+/logo.png"

​
bannerURL
string[]
required
deprecated

URLs to the store banner images Deprecated, use branding.banners.urls instead.

Example:
[
  "https://bucket-prod.getlokki.com/****+/banner1.png",
  "https://bucket-prod.getlokki.com/****+/banner2.png"
]
​
pageUrl
string
required

Public URL for the online store page. UTM parameters may be appended for tracking.

Example:

"https://www.lokki.rent/loueur/my-store?utm_source=partner&utm_medium=social&utm_campaign=spring-sale"

​
currency
object
required
deprecated

Currency used by the store Deprecated, use pricing.currency instead.

​
lat
number
required
deprecated

Latitude of the store location Deprecated, use geo.location.point.lat instead.

Example:

50.62925

​
lng
number
required
deprecated

Longitude of the store location Deprecated, use geo.location.point.lng instead.

Example:

3.057256

​
address
string
required
deprecated

Full address of the store Deprecated, use geo.location.address instead.

Example:

"1 Place du Général de Gaulle, 59000 Lille, France"

​
addressComponents
object
required
deprecated

Address components of the store Deprecated, use geo.location.components instead.

​
googleRating
number
required
deprecated

Google rating of the store Deprecated, use reviews.google.rating instead.

Example:

4.5

​
googleReviewsNb
number
required
deprecated

Number of Google reviews for the store Deprecated, use reviews.google.total instead.

Example:

120

​
verticales
enum<string>[]
required
deprecated

Verticals associated with the store Deprecated, use profile.verticales instead.

Available options:
BIKE,
ELECTRIC_BIKE,
MOPED,
MOTORCYCLE,
CAR,
SCOOTER,
SKI,
CLIMBING,
SNOWSHOES,
SURF,
PADDLE,
CANOE_KAYAK,
BOAT,
EVENT,
MOTOCULTURE,
TOOLING
​
rentalPointSlug
string

Slug of the rental point to get details for. If not provided, main store location is used.

Example:

"my-rental-point"

​
distance
number

Distance from the queried location (in km)

Example:

5