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

get

List all product categories

Query parameters

idsinteger[]Optional

ID(s) of the product categories to retrieve

exclude_connectbooleanOptional

Exclude product categories that belongs to a connected business

with_deletedbooleanOptional

Include deleted product categories

Responses

200

A list of product categories

application/json

get

/product_categories

HTTPcURLJavaScriptPython

GET /private/product_categories HTTP/1.1
Host: api.bookinglayer.io
Accept: */*

200

A list of product categories

[
  {
    "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"
  }
]

Create a product category

post

Create a product category

Body

application/json

idintegerRead-onlyOptional

titlestringRequiredExample: Yoga Mats

colorstringRequiredExample: black

positionintegerRequiredExample: 1

deleted_atstring · date-time · nullableRead-onlyOptional

created_atstring · date-timeRead-onlyOptional

updated_atstring · date-timeRead-onlyOptional

Responses

201

The created product category

application/json

post

/product_categories

HTTPcURLJavaScriptPython

POST /private/product_categories HTTP/1.1
Host: api.bookinglayer.io
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "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

The created product category

{
  "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"
}

Get a product category

get

Get a product category by ID

Path parameters

product_category_idintegerRequired

ID of the product category to get

Responses

200

A product category

application/json

get

/product_categories/{product_category_id}

HTTPcURLJavaScriptPython

GET /private/product_categories/{product_category_id} HTTP/1.1
Host: api.bookinglayer.io
Accept: */*

200

A product category

{
  "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"
}

Delete a product category

delete

Delete a product category by ID

Path parameters

product_category_idintegerRequired

ID of the product category to delete

Responses

204

Product category deleted

400

Invalid request

404

Product category not found

delete

/product_categories/{product_category_id}

HTTPcURLJavaScriptPython

DELETE /private/product_categories/{product_category_id} HTTP/1.1
Host: api.bookinglayer.io
Accept: */*

No content

Update a product category

put

Update a product category by ID

Path parameters

product_category_idintegerRequired

ID of the product category to update

Body

application/json

idintegerRead-onlyOptional

titlestringRequiredExample: Yoga Mats

colorstringRequiredExample: black

positionintegerRequiredExample: 1

deleted_atstring · date-time · nullableRead-onlyOptional

created_atstring · date-timeRead-onlyOptional

updated_atstring · date-timeRead-onlyOptional

Responses

200

The updated product category

application/json

put

/product_categories/{product_category_id}

HTTPcURLJavaScriptPython

PUT /private/product_categories/{product_category_id} HTTP/1.1
Host: api.bookinglayer.io
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "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

The updated product category

{
  "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"
}