Home
v1.0.0
OAS 3.1.0

Distribution API

Designed with <3 by kleesto

Server: https://distribution-api.kleesto.com

Production

Client Libraries
Curl Shell

List all Products

​

Returns a list of Products. You can optionally apply filters to filter the products by their attributes.

Query Parameters
  • pagination
    Type:object
  • embed
    Type:array string[] enum

    Embedded parameters

    • categories
    • destinations
    • amenities
    • cancellationPolicy
    • privacyPolicy
  • filters
    Type:object
Headers
  • X-Api-Key
    Type:string
    required

    Public key for API access

  • X-Secret-Key
    Type:string
    required

    Secret key for API access

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example forGET/products
curl https://distribution-api.kleesto.com/products \
  --header 'X-Api-Key: ' \
  --header 'X-Secret-Key: '

{
  "products": [
    {
      "id": "…",
      "name": "…",
      "subtitle": "…",
      "description": "…",
      "timezone": "…",
      "highlights": [],
      "faq": [],
      "includedInPrice": [],
      "notIncludedInPrice": [],
      "profilePhoto": {
        "name": "…",
        "title": "…",
        "alt": "…",
        "url": "…"
      },
      "coverPhoto": {
        "name": "…",
        "title": "…",
        "alt": "…",
        "url": "…"
      },
      "galleryPhotos": [],
      "cancellationPolicy": {
        "id": "…",
        "name": "…",
        "details": "…",
        "publicLink": "…"
      },
      "privacyPolicy": {
        "id": "…",
        "name": "…",
        "details": "…",
        "publicLink": "…"
      },
      "otherPolicies": [],
      "productType": "activity",
      "pricingType": "perperson",
      "currency": "EUR",
      "minTravelers": 1,
      "maxTravelers": 1,
      "private": false,
      "amenities": [
        {
          "id": "…",
          "name": "…",
          "iconPhoto": {
            "name": "…",
            "title": "…",
            "alt": "…",
            "url": "…"
          }
        }
      ],
      "categories": [
        {
          "id": "…",
          "name": "…",
          "subtitle": "…",
          "description": "…",
          "profilePhoto": {
            "name": "…",
            "title": "…",
            "alt": "…",
            "url": "…"
          },
          "coverPhoto": {
            "name": "…",
            "title": "…",
            "alt": "…",
            "url": "…"
          },
          "iconPhoto": {
            "name": "…",
            "title": "…",
            "alt": "…",
            "url": "…"
          },
          "seoData": {
            "title": "…",
            "description": "…",
            "keywords": []
          },
          "slug": "…"
        }
      ],
      "destinations": [
        {
          "id": "…",
          "title": "…",
          "subtitle": "…",
          "content": "…",
          "profilePhoto": {
            "name": "…",
            "title": "…",
            "alt": "…",
            "url": "…"
          },
          "coverPhoto": {
            "name": "…",
            "title": "…",
            "alt": "…",
            "url": "…"
          },
          "galleryPhotos": [],
          "seoData": {
            "title": "…",
            "description": "…",
            "keywords": []
          },
          "slug": "…"
        }
      ],
      "resources": [
        {
          "id": "…",
          "name": "…",
          "description": "…",
          "specifications": [],
          "slug": "…",
          "type": "BIKE",
          "capacity": 1,
          "characteristics": {
            "registryName": "…",
            "portOfRegistry": "…",
            "registryNo": "…",
            "baseLocationName": "…",
            "avgSpeed": 1,
            "maxSpeed": 1,
            "crewSize": 1,
            "typeOfBoat": "…",
            "manufacturer": "…",
            "model": "…",
            "...": "[Additional Properties Truncated]"
          },
          "photos": []
        }
      ],
      "activeDates": [
        "…"
      ],
      "seoData": {
        "title": "…",
        "description": "…",
        "keywords": []
      },
      "slug": "…",
      "fromPrice": 1,
      "minChargeAmount": 1,
      "discountApplied": true,
      "discountPercentage": 1,
      "location": {
        "id": "…",
        "name": "…",
        "address": "…",
        "location": {
          "lat": 1,
          "lng": 1
        },
        "regionId": "…",
        "photos": []
      },
      "duration": 1
    }
  ],
  "total": 1
}

Successful response

Models