category

GET /api/3.0/category

Retrieve a list of the available categories in the system.

Response JSON Array of Objects:

  • category_id (integer) – The unique ID of the category.

  • name (string) – The display name of the category.

  • pos (integer) – The order in which the category will display.

Public API

If the Public API is enabled, unauthenticated users can make requests to the /category endpoint. This is the same functionality as a customer viewing the categories on the Customer Booking Page. Only categories that are publicly visible and have customer-visible items will be returned. Check out our Knowledge Base for more information on how Categories display on the Booking Page.

 1{
 2    "version": "3.0",
 3    "account_id": 1,
 4    "host_id": "your-company.checkfront.com",
 5    "name": "Your Company",
 6    "locale": {
 7        "id": "en_US",
 8        "lang": "en",
 9        "currency": "CAD"
10    },
11    "request": {
12        "status": "OK",
13        "resource": "category",
14        "records": 6,
15        "limit": 0,
16        "page": 1,
17        "pages": 1,
18        "time": 0.0028,
19        "method": "get"
20    },
21    "query": [],
22    "category": {
23        "2": {
24            "category_id": 2,
25            "name": "Tours",
26            "description": "From Walking, to Bicycles, to Double Decker buses, we have the perfect tour for you and your family.",
27            "pos": 20,
28            "image": "/media/Lcat-2.jpg",
29            "image_url": "https://storage.googleapis.com/cf-public-us/thelondonexperience-67672/media/Lcat-2?t=1522874544771961",
30            "qty": 5
31        },
32        "4": {
33            "category_id": 4,
34            "name": "Accommodations",
35            "description": "Book a Double or Single room for your overnight stay in Manchester.",
36            "pos": 17,
37            "image": "/media/Lcat-4.jpg",
38            "image_url": "https://storage.googleapis.com/cf-public-us/thelondonexperience-67672/media/Lcat-4?t=1522874547513165",
39            "qty": 4
40        },
41        "5": {
42            "category_id": 5,
43            "name": "Gift Certificates",
44            "description": "Give the Gift of The London Experience.",
45            "pos": 16,
46            "image": "/media/Lcat-5.jpg",
47            "image_url": "https://storage.googleapis.com/cf-public-us/thelondonexperience-67672/media/Lcat-5?t=1522874548913993",
48            "qty": 4
49        },
50        "6": {
51            "category_id": 6,
52            "name": "Activities",
53            "description": "",
54            "pos": 19,
55            "image": "/media/Lcat-6.jpg",
56            "image_url": "https://storage.googleapis.com/cf-public-us/thelondonexperience-67672/media/Lcat-6?t=1522874550706040",
57            "qty": 3
58        },
59        "7": {
60            "category_id": 7,
61            "name": "Merchandise",
62            "description": "",
63            "pos": 14,
64            "image": "/media/Lcat-7.jpg",
65            "image_url": "https://storage.googleapis.com/cf-public-us/thelondonexperience-67672/media/Lcat-7?t=1522874552392653",
66            "qty": 3
67        }
68    }
69}