Product Categories

Helps you organise your inventory.

The Product Category object

{
   "id": 32357,
   "title": "Surf lessons",
   "color": "blue",
   "position": 1,
   "deleted_at": null,
   "updated_at": "2024-12-04T10:33:33+00:00",
   "created_at": "2024-12-04T10:33:33+00:00"
}

id

Unique ID of the person.

title

Title visible in your backoffice.

color

Visible in backoffice.

position

The person's initials.

deleted_at

Datetime at which the resource was deleted.

created_at

Datetime at which the resource was created.

updated_at

Datetime at which the resource was last updated.

List product categories

List all product categories

get

/product_categories

Query parameters

idsinteger[]

ID(s) of the product categories to retrieve

exclude_connectboolean

Exclude product categories that belongs to a connected business

with_deletedboolean

Include deleted product categories

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.bookinglayer.io/private/product_categories'

200

200

[
  {
    "color": "black",
    "updated_at": "2000-01-23T04:56:07.000+00:00",
    "created_at": "2000-01-23T04:56:07.000+00:00",
    "id": 0,
    "position": 1,
    "title": "Yoga Mats",
    "deleted_at": "2000-01-23T04:56:07.000+00:00"
  }
]

A list of product categories

Create a product category

Create a product category

post

/product_categories

Body

idinteger

titlestringrequired

Example: Yoga Mats

colorstringrequired

Example: black

positionintegerrequired

Example: 1

deleted_atstring · date-time | nullable

created_atstring · date-time

updated_atstring · date-time

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.bookinglayer.io/private/product_categories' \
  --header 'Content-Type: application/json' \
  --data '{"color":"black","updated_at":"2000-01-23T04:56:07.000+00:00","created_at":"2000-01-23T04:56:07.000+00:00","id":0,"position":1,"title":"Yoga Mats","deleted_at":"2000-01-23T04:56:07.000+00:00"}'

201

201

{
  "color": "black",
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "id": 0,
  "position": 1,
  "title": "Yoga Mats",
  "deleted_at": "2000-01-23T04:56:07.000+00:00"
}

The created product category

Get a product category

Get a product category by ID

get

/product_categories/{product_category_id}

Path parameters

product_category_idintegerrequired

ID of the product category to get

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.bookinglayer.io/private/product_categories/{product_category_id}'

200

200

{
  "color": "black",
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "id": 0,
  "position": 1,
  "title": "Yoga Mats",
  "deleted_at": "2000-01-23T04:56:07.000+00:00"
}

A product category

Delete a product category

Delete a product category by ID

delete

/product_categories/{product_category_id}

Path parameters

product_category_idintegerrequired

ID of the product category to delete

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.bookinglayer.io/private/product_categories/{product_category_id}'

204

400

404

204

No body

Product category deleted

Update a product category

Update a product category by ID

put

/product_categories/{product_category_id}

Path parameters

product_category_idintegerrequired

ID of the product category to update

Body

idinteger

titlestringrequired

Example: Yoga Mats

colorstringrequired

Example: black

positionintegerrequired

Example: 1

deleted_atstring · date-time | nullable

created_atstring · date-time

updated_atstring · date-time

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.bookinglayer.io/private/product_categories/{product_category_id}' \
  --header 'Content-Type: application/json' \
  --data '{"color":"black","updated_at":"2000-01-23T04:56:07.000+00:00","created_at":"2000-01-23T04:56:07.000+00:00","id":0,"position":1,"title":"Yoga Mats","deleted_at":"2000-01-23T04:56:07.000+00:00"}'

200

200

{
  "color": "black",
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "id": 0,
  "position": 1,
  "title": "Yoga Mats",
  "deleted_at": "2000-01-23T04:56:07.000+00:00"
}

The updated product category