🟡Manage Product Items
This page will soon be updated.
We have some problems with product names and API names, so here
Product Item (in UI) equals Inventory Item (in API)
What can you do
Create Product Item
Create inventory item
Authorizations
Path parameters
company_idstring · uuidRequired
Body
namestring · min: 1Optional
vendor_codestring | nullOptional
descriptionstring | nullOptional
short_descriptionstring | nullOptional
imagestring | nullOptional
linkstring | nullOptional
pricestring | nullOptionalPattern:
^-?\d{0,8}(?:\.\d{0,2})?$
currencyone ofOptional
string · enumOptionalPossible values:
AED
- United Arab Emirates DirhamAUD
- Australian DollarBRL
- Brazilian RealCAD
- Canadian DollarCHF
- Swiss FrancCNY
- Chinese YuanDKK
- Danish KroneEUR
- EuroGBP
- British PoundHKD
- Hong Kong DollarILS
- Israeli New ShekelINR
- Indian RupeeIQD
- Iraqi DinarJPY
- Japanese YenKRW
- South Korean WonMXN
- Mexican PesoMYR
- Malaysian RinggitNOK
- Norwegian KroneNZD
- New Zealand DollarPLN
- Polish ZlotyRUB
- Russian RubleSAR
- Saudi RiyalSEK
- Swedish KronaSGD
- Singapore DollarTHB
- Thai BahtTRY
- Turkish LiraUSD
- US DollarZAR
- South African Rand
undefined · enumOptionalPossible values:
nullOptional
compare_at_pricestring | nullOptionalPattern:
^-?\d{0,8}(?:\.\d{0,2})?$
priorityinteger · min: -2147483648 · max: 2147483647Optional
cart_integration_idstring | nullOptional
statusstring · enumOptionalPossible values:
active
- Activedraft
- Draftarchived
- Archived
categoryone ofOptional
string · enumOptionalPossible values:
makeup_remover
- Make-up removercleanser
- Cleansertoner
- Tonerexfoliator
- Exfoliatormasks_patches
- Masks & Patchestreatment
- Treatmenteye_care
- Eye caremoisturizer
- Moisturizersunscreen
- Sunscreen
undefined · enumOptionalPossible values:
nullOptional
how_often_to_applyone ofOptional
string · enumOptionalPossible values:
daily
- Dailyweekly
- Weeklymonthly
- Monthlyas_needed
- As needed
undefined · enumOptionalPossible values:
nullOptional
tagging_modestring · enumOptionalPossible values:
manual
- Manualauto
- Auto
is_featuredbooleanOptional
Responses
201Success
application/json
400Error
application/json
post
POST /api/v1/companies/{company_id}/inventory_items/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 433
{
"name": "text",
"vendor_code": null,
"description": null,
"short_description": null,
"image": null,
"link": null,
"price": null,
"currency": "AED",
"compare_at_price": null,
"priority": 1,
"cart_integration_id": null,
"status": "active",
"category": "makeup_remover",
"skin_type": [
"normal"
],
"concerns": [
"breakouts"
],
"when_to_apply": [
"am"
],
"how_often_to_apply": "daily",
"active_ingredients": [
"aha"
],
"other": [
"vegan"
],
"tagging_mode": "manual",
"is_featured": true
}
{
"id": 1,
"company_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"vendor_code": null,
"description": null,
"short_description": null,
"image": null,
"link": null,
"price": null,
"currency": "AED",
"compare_at_price": null,
"priority": 1,
"created_at": "2025-10-08T17:32:28.262Z",
"updated_at": "2025-10-08T17:32:28.262Z",
"cart_integration_id": null,
"tags": null,
"status": "active",
"attached_to_shelves": 0,
"inventory_item_sets": [
{
"id": 1,
"name": "text",
"description": "text",
"is_locked": false,
"inventory_items_count": 0,
"created_at": "2025-10-08T17:32:28.262Z",
"updated_at": "2025-10-08T17:32:28.262Z"
}
],
"is_locked": false,
"out_of_stock": true,
"category": "makeup_remover",
"skin_type": [
"normal"
],
"concerns": [
"breakouts"
],
"when_to_apply": [
"am"
],
"how_often_to_apply": "daily",
"active_ingredients": [
"aha"
],
"other": [
"vegan"
],
"tagging_mode": "manual",
"tagging_status": "pending",
"tagging_status_updated_at": "2025-10-08T17:32:28.262Z",
"is_ready_to_sell": false,
"is_featured": true
}
Update Product Item
Update inventory item
Authorizations
Path parameters
company_idstring · uuidRequired
idintegerRequired
A unique integer value identifying this Inventory Item.
Body
namestring · min: 1Optional
vendor_codestring | nullOptional
descriptionstring | nullOptional
short_descriptionstring | nullOptional
imagestring | nullOptional
linkstring | nullOptional
pricestring | nullOptionalPattern:
^-?\d{0,8}(?:\.\d{0,2})?$
currencyone ofOptional
string · enumOptionalPossible values:
AED
- United Arab Emirates DirhamAUD
- Australian DollarBRL
- Brazilian RealCAD
- Canadian DollarCHF
- Swiss FrancCNY
- Chinese YuanDKK
- Danish KroneEUR
- EuroGBP
- British PoundHKD
- Hong Kong DollarILS
- Israeli New ShekelINR
- Indian RupeeIQD
- Iraqi DinarJPY
- Japanese YenKRW
- South Korean WonMXN
- Mexican PesoMYR
- Malaysian RinggitNOK
- Norwegian KroneNZD
- New Zealand DollarPLN
- Polish ZlotyRUB
- Russian RubleSAR
- Saudi RiyalSEK
- Swedish KronaSGD
- Singapore DollarTHB
- Thai BahtTRY
- Turkish LiraUSD
- US DollarZAR
- South African Rand
undefined · enumOptionalPossible values:
nullOptional
compare_at_pricestring | nullOptionalPattern:
^-?\d{0,8}(?:\.\d{0,2})?$
priorityinteger · min: -2147483648 · max: 2147483647Optional
cart_integration_idstring | nullOptional
statusstring · enumOptionalPossible values:
active
- Activedraft
- Draftarchived
- Archived
categoryone ofOptional
string · enumOptionalPossible values:
makeup_remover
- Make-up removercleanser
- Cleansertoner
- Tonerexfoliator
- Exfoliatormasks_patches
- Masks & Patchestreatment
- Treatmenteye_care
- Eye caremoisturizer
- Moisturizersunscreen
- Sunscreen
undefined · enumOptionalPossible values:
nullOptional
how_often_to_applyone ofOptional
string · enumOptionalPossible values:
daily
- Dailyweekly
- Weeklymonthly
- Monthlyas_needed
- As needed
undefined · enumOptionalPossible values:
nullOptional
tagging_modestring · enumOptionalPossible values:
manual
- Manualauto
- Auto
is_featuredbooleanOptional
Responses
200Success
application/json
400Error
application/json
patch
PATCH /api/v1/companies/{company_id}/inventory_items/{id}/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 433
{
"name": "text",
"vendor_code": null,
"description": null,
"short_description": null,
"image": null,
"link": null,
"price": null,
"currency": "AED",
"compare_at_price": null,
"priority": 1,
"cart_integration_id": null,
"status": "active",
"category": "makeup_remover",
"skin_type": [
"normal"
],
"concerns": [
"breakouts"
],
"when_to_apply": [
"am"
],
"how_often_to_apply": "daily",
"active_ingredients": [
"aha"
],
"other": [
"vegan"
],
"tagging_mode": "manual",
"is_featured": true
}
{
"id": 1,
"company_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"vendor_code": null,
"description": null,
"short_description": null,
"image": null,
"link": null,
"price": null,
"currency": "AED",
"compare_at_price": null,
"priority": 1,
"created_at": "2025-10-08T17:32:28.262Z",
"updated_at": "2025-10-08T17:32:28.262Z",
"cart_integration_id": null,
"tags": null,
"status": "active",
"attached_to_shelves": 0,
"inventory_item_sets": [
{
"id": 1,
"name": "text",
"description": "text",
"is_locked": false,
"inventory_items_count": 0,
"created_at": "2025-10-08T17:32:28.262Z",
"updated_at": "2025-10-08T17:32:28.262Z"
}
],
"is_locked": false,
"out_of_stock": true,
"category": "makeup_remover",
"skin_type": [
"normal"
],
"concerns": [
"breakouts"
],
"when_to_apply": [
"am"
],
"how_often_to_apply": "daily",
"active_ingredients": [
"aha"
],
"other": [
"vegan"
],
"tagging_mode": "manual",
"tagging_status": "pending",
"tagging_status_updated_at": "2025-10-08T17:32:28.262Z",
"is_ready_to_sell": false,
"is_featured": true
}
Get Product Item Info
Retrieve inventory item
Authorizations
Path parameters
company_idstring · uuidRequired
idintegerRequired
A unique integer value identifying this Inventory Item.
Responses
200Success
application/json
get
GET /api/v1/companies/{company_id}/inventory_items/{id}/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
"id": 1,
"company_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"vendor_code": null,
"description": null,
"short_description": null,
"image": null,
"link": null,
"price": null,
"currency": "AED",
"compare_at_price": null,
"priority": 1,
"created_at": "2025-10-08T17:32:28.262Z",
"updated_at": "2025-10-08T17:32:28.262Z",
"cart_integration_id": null,
"tags": null,
"status": "active",
"attached_to_shelves": 0,
"inventory_item_sets": [
{
"id": 1,
"name": "text",
"description": "text",
"is_locked": false,
"inventory_items_count": 0,
"created_at": "2025-10-08T17:32:28.262Z",
"updated_at": "2025-10-08T17:32:28.262Z"
}
],
"is_locked": false,
"out_of_stock": true,
"category": "makeup_remover",
"skin_type": [
"normal"
],
"concerns": [
"breakouts"
],
"when_to_apply": [
"am"
],
"how_often_to_apply": "daily",
"active_ingredients": [
"aha"
],
"other": [
"vegan"
],
"tagging_mode": "manual",
"tagging_status": "pending",
"tagging_status_updated_at": "2025-10-08T17:32:28.262Z",
"is_ready_to_sell": false,
"is_featured": true
}
List Product Items
List inventory items
Authorizations
Path parameters
company_idstring · uuidRequired
Query parameters
idinteger[]Optional
Multiple values may be separated by commas.
priorityintegerOptional
sourcestringOptional
Source
inventory_item_set_idnumberOptional
Inventory item set ID
is_ready_to_sellbooleanOptional
Is ready to sell
is_featuredbooleanOptional
Is featured
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
400Error
application/json
get
GET /api/v1/companies/{company_id}/inventory_items/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 1,
"company_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"vendor_code": null,
"description": null,
"short_description": null,
"image": null,
"link": null,
"price": null,
"currency": "AED",
"compare_at_price": null,
"priority": 1,
"created_at": "2025-10-08T17:32:28.262Z",
"updated_at": "2025-10-08T17:32:28.262Z",
"cart_integration_id": null,
"tags": null,
"status": "active",
"attached_to_shelves": 0,
"inventory_item_sets": [
{
"id": 1,
"name": "text",
"description": "text",
"is_locked": false,
"inventory_items_count": 0,
"created_at": "2025-10-08T17:32:28.262Z",
"updated_at": "2025-10-08T17:32:28.262Z"
}
],
"is_locked": false,
"out_of_stock": true,
"category": "makeup_remover",
"skin_type": [
"normal"
],
"concerns": [
"breakouts"
],
"when_to_apply": [
"am"
],
"how_often_to_apply": "daily",
"active_ingredients": [
"aha"
],
"other": [
"vegan"
],
"tagging_mode": "manual",
"tagging_status": "pending",
"tagging_status_updated_at": "2025-10-08T17:32:28.262Z",
"is_ready_to_sell": false,
"is_featured": true
}
]
}
Delete Product Item(s) in a bulk manner
post
Authorizations
Path parameters
company_idstring · uuidRequired
Query parameters
forcebooleanOptionalDefault:
false
Body
idsinteger[]Required
Responses
200Success
application/json
400Error
application/json
post
POST /api/v1/companies/{company_id}/inventory_items/bulk_delete/ HTTP/1.1
Host: saas.haut.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 11
{
"ids": [
1
]
}
{
"id": 1,
"company_id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"vendor_code": null,
"description": null,
"short_description": null,
"image": null,
"link": null,
"price": null,
"currency": "AED",
"compare_at_price": null,
"priority": 1,
"created_at": "2025-10-08T17:32:28.262Z",
"updated_at": "2025-10-08T17:32:28.262Z",
"cart_integration_id": null,
"tags": null,
"status": "active",
"attached_to_shelves": 0,
"inventory_item_sets": [
{
"id": 1,
"name": "text",
"description": "text",
"is_locked": false,
"inventory_items_count": 0,
"created_at": "2025-10-08T17:32:28.262Z",
"updated_at": "2025-10-08T17:32:28.262Z"
}
],
"is_locked": false,
"out_of_stock": true,
"category": "makeup_remover",
"skin_type": [
"normal"
],
"concerns": [
"breakouts"
],
"when_to_apply": [
"am"
],
"how_often_to_apply": "daily",
"active_ingredients": [
"aha"
],
"other": [
"vegan"
],
"tagging_mode": "manual",
"tagging_status": "pending",
"tagging_status_updated_at": "2025-10-08T17:32:28.262Z",
"is_ready_to_sell": false,
"is_featured": true
}
Last updated
Was this helpful?