API Listing Endpoints

This document provides details about the endpoints used in the Funbooker Listing API.

GET - Retrieve a list of listings

• Endpoint: GET /api/partner/v1/listings

• Description: This endpoint retrieves a list of listings with optional parameters.

• Query Parameters:

  • page (int, optional): The page number for pagination. Default is 1.

  • perPage (int, optional): The number of listings per page. Default is 25.

  • search (string, optional): Free text search within listing titles.

  • occasion (string, optional): Filter by occasion, on of entertainment, gift, birthday, business, bachelor-party, internship

• Response Example:

{
  "data": [
    {
      "id": 12345,
      "slug": "rando-montagne",
      "title": "Rando montagne",
      "atHome": true,
      "isInstant": true,
      "pictureUrl": "https://res.cloudinary.com/funbooker/image/upload/ar_4:3,c_scale,dpr_auto,f_auto,q_auto,t_lr-medium,w_900/v1/marketplace-listing/cbravrsalu3l3grcgod2",
      "listingItems": [
        {
          "id": 12345,
          "listingId": 12345,
          "label": "Titre listing item",
          "description": "Prix / personne",
          "isOption": false,
          "maxCapacity": 123456,
          "minCapacity": 123456,
          "durationTime": 123456,
          "price": 123456,
          "priceType": "per_person",
          "numberOfPersons": 123456
        }
      ],
      "funpro": {
        "id": 12345,
        "name": "Macarong",
        "pictureUrl": "https://res.cloudinary.com/funbooker/image/upload/f_auto,q_auto,w_40,h_40,dpr_3.0/v1/marketplace-user/e3nx9dmdoq5je3ueisib"
      },
      "updated": "2021-05-20T09:25:32+00:00",
      "averageRating": 3.5,
      "ratingCount": 12345,
      "address": {
        "city": "Montpellier",
        "country": "France",
        "route": "rue des tulipes",
        "streetNumber": "145",
        "zip": "34000"
      },
      "specialCondition": "Lorem ipsum",
      "cancellationPolicy": {
        "policy": "Flexible",
        "details": "Full refund up to 24 hours before the activity."
      },
      "minPerson": 1,
      "maxPerson": 15,
      "displayListingEndTime": false,
      "checkoutLinks": [
        {
          "href": "https://www.funbooker.com/fr/checkout/gift_voucher/new/vol-acrobatique-en-parapente-a-millau-12",
          "shortLabel": "Offrir un bon cadeau"
        }
      ],
      "latitude": 15.23456,
      "longitude": -30.67890,
      "description": "Rando montagne"
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 25,
    "total": 100
  }
}

GET - Retrieve details of a specific listing

• Endpoint: GET /api/partner/v1/listing/{slug}

• Description: This endpoint retrieves details of a specific listing by its slug.

• Path Parameters:

  • slug (string): The slug of the listing.

• Response Example:

  {
    "id": 12345,
    "slug": "rando-montagne",
    "title": "Rando montagne",
    "atHome": true,
    "isInstant": true,
    "pictureUrl": "https://res.cloudinary.com/funbooker/image/upload/ar_4:3,c_scale,dpr_auto,f_auto,q_auto,t_lr-medium,w_900/v1/marketplace-listing/cbravrsalu3l3grcgod2",
    "listingItems": [
      {
        "id": 12345,
        "listingId": 12345,
        "label": "Titre listing item",
        "description": "Prix / personne",
        "isOption": false,
        "maxCapacity": 123456,
        "minCapacity": 123456,
        "durationTime": 123456,
        "price": 123456,
        "priceType": "per_person",
        "numberOfPersons": 123456
      }
    ],
    "funpro": {
      "id": 12345,
      "name": "Macarong",
      "pictureUrl": "https://res.cloudinary.com/funbooker/image/upload/f_auto,q_auto,w_40,h_40,dpr_3.0/v1/marketplace-user/e3nx9dmdoq5je3ueisib"
    },
    "updated": "2021-05-20T09:25:32+00:00",
    "averageRating": 3.5,
    "ratingCount": 12345,
    "address": {
      "city": "Montpellier",
      "country": "France",
      "route": "rue des tulipes",
      "streetNumber": "145",
      "zip": "34000"
    },
    "specialCondition": "Lorem ipsum",
    "cancellationPolicy": {
      "policy": "Flexible",
      "details": "Full refund up to 24 hours before the activity."
    },
    "minPerson": 1,
    "maxPerson": 15,
    "displayListingEndTime": false,
    "checkoutLinks": [
      {
        "href": "https://www.funbooker.com/fr/checkout/gift_voucher/new/vol-acrobatique-en-parapente-a-millau-12",
        "shortLabel": "Offrir un bon cadeau"
      }
    ],
    "latitude": 15.23456,
    "longitude": -30.67890,
    "description": "Rando montagne"
  }