🟡Manage Product Shelves

This page will soon be updated.

We have some problems with product names and API names, so here

Product Shelf (in UI) equals Inventory Item Set (in API)

What can you do

Create Product shelf

Create inventory item set

post

Create inventory item set

Authorizations

Path parameters

company_idstring · uuidRequired

Body

namestring · min: 1Required

descriptionstringOptional

Responses

201Success

application/json

400Error

application/json

post

POST /api/v1/companies/{company_id}/inventory_item_sets/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}

{
  "id": 1,
  "name": "text",
  "description": "text",
  "is_locked": false,
  "inventory_items_count": 0,
  "created_at": "2025-10-08T20:48:34.517Z",
  "updated_at": "2025-10-08T20:48:34.517Z"
}

Update Product Shelf

Update inventory item set

patch

Update inventory item set

Authorizations

Path parameters

company_idstring · uuidRequired

idintegerRequired

A unique integer value identifying this Inventory Item Set.

Body

namestring · min: 1Optional

descriptionstringOptional

Responses

200Success

application/json

400Error

application/json

patch

PATCH /api/v1/companies/{company_id}/inventory_item_sets/{id}/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}

{
  "id": 1,
  "name": "text",
  "description": "text",
  "is_locked": false,
  "inventory_items_count": 0,
  "created_at": "2025-10-08T20:48:34.517Z",
  "updated_at": "2025-10-08T20:48:34.517Z"
}

List Product Shelves

List inventory item sets

get

List inventory item sets

Authorizations

Path parameters

company_idstring · uuidRequired

Query parameters

orderingstringOptional

Which field to use when ordering the results.

qstringOptional

A search term.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Responses

200Success

application/json

get

GET /api/v1/companies/{company_id}/inventory_item_sets/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "is_locked": false,
      "inventory_items_count": 0,
      "created_at": "2025-10-08T20:48:34.517Z",
      "updated_at": "2025-10-08T20:48:34.517Z"
    }
  ]
}

Get Product Shelf info

Retrieve inventory item set

get

Retrieve inventory item set

Authorizations

Path parameters

company_idstring · uuidRequired

idintegerRequired

A unique integer value identifying this Inventory Item Set.

Responses

200Success

application/json

get

GET /api/v1/companies/{company_id}/inventory_item_sets/{id}/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": 1,
  "name": "text",
  "description": "text",
  "is_locked": false,
  "inventory_items_count": 0,
  "created_at": "2025-10-08T20:48:34.517Z",
  "updated_at": "2025-10-08T20:48:34.517Z"
}

Add Product Items to Product Shelf

Bulk add inventory items to inventory item set

post

Bulk add inventory items to inventory item set

Authorizations

Path parameters

company_idstring · uuidRequired

idintegerRequired

A unique integer value identifying this Inventory Item Set.

Body

inventory_item_idsinteger[]Required

A list of InventoryItem IDs to add or remove.

Responses

200Success

application/json

400Error

application/json

post

POST /api/v1/companies/{company_id}/inventory_item_sets/{id}/bulk_add_inventory_items/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "inventory_item_ids": [
    1
  ]
}

{
  "id": 1,
  "name": "text",
  "description": "text",
  "is_locked": false,
  "inventory_items_count": 0,
  "created_at": "2025-10-08T20:48:34.517Z",
  "updated_at": "2025-10-08T20:48:34.517Z"
}

Remove Product Items from Product Shelf

Bulk remove inventory items from inventory item set

post

Bulk remove inventory items from inventory item set

Authorizations

Path parameters

company_idstring · uuidRequired

idintegerRequired

A unique integer value identifying this Inventory Item Set.

Body

inventory_item_idsinteger[]Required

A list of InventoryItem IDs to add or remove.

Responses

200Success

application/json

400Error

application/json

post

POST /api/v1/companies/{company_id}/inventory_item_sets/{id}/bulk_remove_inventory_items/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "inventory_item_ids": [
    1
  ]
}

{
  "id": 1,
  "name": "text",
  "description": "text",
  "is_locked": false,
  "inventory_items_count": 0,
  "created_at": "2025-10-08T20:48:34.517Z",
  "updated_at": "2025-10-08T20:48:34.517Z"
}

Delete Product Shelf

Delete inventory item set

delete

Delete inventory item set

Authorizations

Path parameters

company_idstring · uuidRequired

idintegerRequired

A unique integer value identifying this Inventory Item Set.

Responses

204

No response body

No content

delete

DELETE /api/v1/companies/{company_id}/inventory_item_sets/{id}/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No response body

No content

PreviousManage Product Items NextChangelog

Last updated 7 months ago

Was this helpful?