🟡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

post

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 · enumOptional
  • AED - United Arab Emirates Dirham
  • AUD - Australian Dollar
  • BRL - Brazilian Real
  • CAD - Canadian Dollar
  • CHF - Swiss Franc
  • CNY - Chinese Yuan
  • DKK - Danish Krone
  • EUR - Euro
  • GBP - British Pound
  • HKD - Hong Kong Dollar
  • ILS - Israeli New Shekel
  • INR - Indian Rupee
  • IQD - Iraqi Dinar
  • JPY - Japanese Yen
  • KRW - South Korean Won
  • MXN - Mexican Peso
  • MYR - Malaysian Ringgit
  • NOK - Norwegian Krone
  • NZD - New Zealand Dollar
  • PLN - Polish Zloty
  • RUB - Russian Ruble
  • SAR - Saudi Riyal
  • SEK - Swedish Krona
  • SGD - Singapore Dollar
  • THB - Thai Baht
  • TRY - Turkish Lira
  • USD - US Dollar
  • ZAR - South African Rand
Possible values:
or
undefined · enumOptionalPossible values:
or
nullOptional
compare_at_pricestring | nullOptionalPattern: ^-?\d{0,8}(?:\.\d{0,2})?$
priorityinteger · min: -2147483648 · max: 2147483647Optional
cart_integration_idstring | nullOptional
statusstring · enumOptional
  • active - Active
  • draft - Draft
  • archived - Archived
Possible values:
categoryone ofOptional
string · enumOptional
  • makeup_remover - Make-up remover
  • cleanser - Cleanser
  • toner - Toner
  • exfoliator - Exfoliator
  • masks_patches - Masks & Patches
  • treatment - Treatment
  • eye_care - Eye care
  • moisturizer - Moisturizer
  • sunscreen - Sunscreen
Possible values:
or
undefined · enumOptionalPossible values:
or
nullOptional
how_often_to_applyone ofOptional
string · enumOptional
  • daily - Daily
  • weekly - Weekly
  • monthly - Monthly
  • as_needed - As needed
Possible values:
or
undefined · enumOptionalPossible values:
or
nullOptional
tagging_modestring · enumOptional
  • manual - Manual
  • auto - Auto
Possible values:
is_featuredbooleanOptional
Responses
201Success
application/json
post
/api/v1/companies/{company_id}/inventory_items/
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-29T11:08:39.528Z",
  "updated_at": "2025-10-29T11:08:39.528Z",
  "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-29T11:08:39.528Z",
      "updated_at": "2025-10-29T11:08:39.528Z"
    }
  ],
  "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-29T11:08:39.528Z",
  "is_ready_to_sell": false,
  "is_featured": true
}

Update Product Item

Update inventory item

patch

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 · enumOptional
  • AED - United Arab Emirates Dirham
  • AUD - Australian Dollar
  • BRL - Brazilian Real
  • CAD - Canadian Dollar
  • CHF - Swiss Franc
  • CNY - Chinese Yuan
  • DKK - Danish Krone
  • EUR - Euro
  • GBP - British Pound
  • HKD - Hong Kong Dollar
  • ILS - Israeli New Shekel
  • INR - Indian Rupee
  • IQD - Iraqi Dinar
  • JPY - Japanese Yen
  • KRW - South Korean Won
  • MXN - Mexican Peso
  • MYR - Malaysian Ringgit
  • NOK - Norwegian Krone
  • NZD - New Zealand Dollar
  • PLN - Polish Zloty
  • RUB - Russian Ruble
  • SAR - Saudi Riyal
  • SEK - Swedish Krona
  • SGD - Singapore Dollar
  • THB - Thai Baht
  • TRY - Turkish Lira
  • USD - US Dollar
  • ZAR - South African Rand
Possible values:
or
undefined · enumOptionalPossible values:
or
nullOptional
compare_at_pricestring | nullOptionalPattern: ^-?\d{0,8}(?:\.\d{0,2})?$
priorityinteger · min: -2147483648 · max: 2147483647Optional
cart_integration_idstring | nullOptional
statusstring · enumOptional
  • active - Active
  • draft - Draft
  • archived - Archived
Possible values:
categoryone ofOptional
string · enumOptional
  • makeup_remover - Make-up remover
  • cleanser - Cleanser
  • toner - Toner
  • exfoliator - Exfoliator
  • masks_patches - Masks & Patches
  • treatment - Treatment
  • eye_care - Eye care
  • moisturizer - Moisturizer
  • sunscreen - Sunscreen
Possible values:
or
undefined · enumOptionalPossible values:
or
nullOptional
how_often_to_applyone ofOptional
string · enumOptional
  • daily - Daily
  • weekly - Weekly
  • monthly - Monthly
  • as_needed - As needed
Possible values:
or
undefined · enumOptionalPossible values:
or
nullOptional
tagging_modestring · enumOptional
  • manual - Manual
  • auto - Auto
Possible values:
is_featuredbooleanOptional
Responses
200Success
application/json
patch
/api/v1/companies/{company_id}/inventory_items/{id}/
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-29T11:08:39.528Z",
  "updated_at": "2025-10-29T11:08:39.528Z",
  "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-29T11:08:39.528Z",
      "updated_at": "2025-10-29T11:08:39.528Z"
    }
  ],
  "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-29T11:08:39.528Z",
  "is_ready_to_sell": false,
  "is_featured": true
}

Get Product Item Info

Retrieve inventory item

get

Retrieve inventory item

Authorizations
Path parameters
company_idstring · uuidRequired
idintegerRequired

A unique integer value identifying this Inventory Item.

Responses
200Success
application/json
get
/api/v1/companies/{company_id}/inventory_items/{id}/
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-29T11:08:39.528Z",
  "updated_at": "2025-10-29T11:08:39.528Z",
  "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-29T11:08:39.528Z",
      "updated_at": "2025-10-29T11:08:39.528Z"
    }
  ],
  "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-29T11:08:39.528Z",
  "is_ready_to_sell": false,
  "is_featured": true
}

List Product Items

List inventory items

get

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
get
/api/v1/companies/{company_id}/inventory_items/
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-29T11:08:39.528Z",
      "updated_at": "2025-10-29T11:08:39.528Z",
      "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-29T11:08:39.528Z",
          "updated_at": "2025-10-29T11:08:39.528Z"
        }
      ],
      "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-29T11:08:39.528Z",
      "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
post
/api/v1/companies/{company_id}/inventory_items/bulk_delete/
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-29T11:08:39.528Z",
  "updated_at": "2025-10-29T11:08:39.528Z",
  "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-29T11:08:39.528Z",
      "updated_at": "2025-10-29T11:08:39.528Z"
    }
  ],
  "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-29T11:08:39.528Z",
  "is_ready_to_sell": false,
  "is_featured": true
}

PreviousAPI for Product InventoryNextManage Product Shelves

Last updated

Was this helpful?