Product

INFO

Every response arrives in the shared envelope — code, message, messages, status_code, time — with the payload in data. The tables below describe what is inside data.

POST /product/create

This method allows adding product into the account.

Request body

Field	Type	Required	Description
name	string	Yes
note	string	No
measure_id	string	Yes	id of measure unit
category_id	string	No	id of product categories
box_type_id	string	No	id of Box type
box_item	number	No	number of items that exist in one box. Default: 0
box_item_barcode	string	No	id of box item's barcode
sku	string	Yes	local unique id of product
barcode	string	No	barcode of product
supplier_ids	string[]	No	list of supplier ids
warehouse_number	string	No	Product's location in the warehouse (aisle/shelf/bin label). Optional, free-form.
image	string	No	image path of product that uploaded to the server
is_compound	boolean	No	is compound product or not. Default: false
materials	object[]	No	list of materials of product. required if is_compound is true
materials[].material_id	string	Yes
materials[].amount	number	Yes
materials[].box_count	integer	No
barcodes	object[]	No	list of barcodes of product
barcodes[].is_active	boolean	No
barcodes[].barcode	string	No
is_semi_product	boolean	Yes	is semi product or not. Default: false
is_product	boolean	Yes	is product or not. Default: false
is_material	boolean	Yes	is material or not. Default: false
is_marked	boolean	Yes	is marked or not. Default: false
dimension	object	No	dimension of product
dimension.shape	string	No	One of: circular, rectangular, other
dimension.netto_weight	number	No
dimension.gross_weight	number	No
dimension.height	number	No
dimension.volume	number	No
dimension.diameter	number	No
dimension.width	number	No
dimension.length	number	No
is_variant	boolean	No	is variant or not. Default: false
variants	object[]	No
variants[].sku	string	Yes
variants[].barcode	string	No
variants[].image	boolean	No
variants[].organizations	object[]	Yes
variants[].organizations[].organization_id	string	Yes
variants[].organizations[].is_available	boolean	Yes
variants[].organizations[].max_stock	number	No
variants[].organizations[].yellow_line	number	No
variants[].organizations[].red_line	number	No
variants[].organizations[].standard	number	No
variants[].organizations[].is_available_for_sale	boolean	No
variants[].attributes	object[]	Yes
variants[].attributes[].attribute_id	string	Yes
variants[].attributes[].attribute_item_id	string	Yes
organizations	object[]	Yes
organizations[].organization_id	string	Yes
organizations[].is_available	boolean	Yes
organizations[].max_stock	number	No
organizations[].yellow_line	number	No
organizations[].red_line	number	No
organizations[].standard	number	No
organizations[].is_available_for_sale	boolean	No
organizations[].prices	object[]	No	list of prices with optional UOM prices
organizations[].prices[].price_id	string	Yes
organizations[].prices[].amount	number	No
organizations[].prices[].uom_prices	object[]	No

{
  "name": "string",
  "note": "string",
  "measure_id": "67b486d242ed76693cd2cc59",
  "category_id": "67b486d242ed76693cd2cc59",
  "box_type_id": "67b486d242ed76693cd2cc59",
  "box_item": 0,
  "box_item_barcode": "string",
  "sku": "string",
  "barcode": "string",
  "supplier_ids": [
    "string"
  ],
  "warehouse_number": "string",
  "image": "string",
  "is_compound": false,
  "materials": [
    {
      "material_id": "67b486d242ed76693cd2cc59",
      "amount": 0,
      "box_count": 0
    }
  ],
  "barcodes": [
    {
      "is_active": false,
      "barcode": "string"
    }
  ],
  "is_semi_product": false,
  "is_product": false,
  "is_material": false,
  "is_marked": false,
  "dimension": {
    "shape": "circular",
    "netto_weight": 0,
    "gross_weight": 0,
    "height": 0,
    "volume": 0,
    "diameter": 0,
    "width": 0,
    "length": 0
  },
  "is_variant": false,
  "variants": [
    {
      "sku": "string",
      "barcode": "string",
      "image": false,
      "organizations": [],
      "attributes": []
    }
  ],
  "organizations": [
    {
      "organization_id": "67b486d242ed76693cd2cc59",
      "is_available": false,
      "max_stock": 0,
      "yellow_line": 0,
      "red_line": 0,
      "standard": 0,
      "is_available_for_sale": false,
      "prices": []
    }
  ]
}

Response

Field	Type	Description
_id	string	id of product
created_at	string
updated_at	string
name	string
number	string
note	string
box_item	number
box_item_barcode	string
box_type_id	string
box_type	object
box_type._id	string
box_type.code	string
box_type.short_name	string
box_type.name	string
measure	object
measure._id	string
measure.system_code	string
measure.code	string
measure.short_name	string
measure.name	string
measure.decimal_count	number
sku	string
barcode	string
barcodes	object[]	list of barcodes of product
barcodes[].is_active	boolean
barcodes[].barcode	string
supplier_ids	string[]	list of supplier ids
warehouse_number	string	Product's location in the warehouse (aisle/shelf/bin label). Absent when not set.
image	string	image path of product that uploaded to the server
materials	object[]	list of materials of product. required if is_compound is true
materials[].material_id	string
materials[].amount	number
materials[].box_count	integer
materials[].material	object
materials[].material._id	string
materials[].material.name	string
materials[].material.sku	string
is_compound	boolean	is compound product or not
is_marked	boolean	is marked or not
is_product	boolean	is product or not. Default: false
is_material	boolean	is material or not. Default: false
is_semi_product	boolean	is semi product or not. Default: false
dimension	object	dimension of product
dimension.shape	string	One of: circular, rectangular, other
dimension.netto_weight	number
dimension.gross_weight	number
dimension.height	number
dimension.volume	number
dimension.diameter	number
dimension.width	number
dimension.length	number
is_variant	boolean	is variant or not
is_parent	boolean	is parent or not
attributes	object[]
attributes[].attribute_id	string
attributes[].attribute_item_id	string
parent_id	string	id of parent product. it depends on variant product
organizations	object[]
organizations[].organization_id	string
organizations[].is_available	boolean
organizations[].max_stock	number
organizations[].yellow_line	number
organizations[].red_line	number
organizations[].standard	number
organizations[].is_available_for_sale	boolean
organizations[].prices	object[]	list of prices with optional UOM prices
organizations[].prices[].price_id	string
organizations[].prices[].amount	number
organizations[].prices[].uom_prices	object[]
tax_ids	string[]	list of tax ids
discount_ids	string[]	list of discount ids
category	object
category._id	string
category.name	string
custom_fields	object[]
custom_fields[]._id	string
custom_fields[].value	string

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "_id": "67b486d242ed76693cd2cc59",
    "created_at": "2023-10-01T12:00:00Z",
    "updated_at": "2023-10-01T12:00:00Z",
    "name": "string",
    "number": "string",
    "note": "string",
    "box_item": 0,
    "box_item_barcode": "string",
    "box_type_id": "67b486d242ed76693cd2cc59",
    "box_type": {
      "_id": "67b486d242ed76693cd2cc59",
      "code": "string",
      "short_name": "string",
      "name": "string"
    },
    "measure": {
      "_id": "67b486d242ed76693cd2cc59",
      "system_code": "string",
      "code": "string",
      "short_name": "string",
      "name": "string",
      "decimal_count": 0
    },
    "sku": "string",
    "barcode": "string",
    "barcodes": [
      {
        "is_active": false,
        "barcode": "string"
      }
    ],
    "supplier_ids": [
      "string"
    ],
    "warehouse_number": "string",
    "image": "string",
    "materials": [
      {
        "material_id": "67b486d242ed76693cd2cc59",
        "amount": 0,
        "box_count": 0,
        "material": {
          "_id": null,
          "name": null,
          "sku": null
        }
      }
    ],
    "is_compound": false,
    "is_marked": false,
    "is_product": false,
    "is_material": false,
    "is_semi_product": false,
    "dimension": {
      "shape": "circular",
      "netto_weight": 0,
      "gross_weight": 0,
      "height": 0,
      "volume": 0,
      "diameter": 0,
      "width": 0,
      "length": 0
    },
    "is_variant": false,
    "is_parent": false,
    "attributes": [
      {
        "attribute_id": "string",
        "attribute_item_id": "string"
      }
    ],
    "parent_id": "67b486d242ed76693cd2cc59",
    "organizations": [
      {
        "organization_id": "67b486d242ed76693cd2cc59",
        "is_available": false,
        "max_stock": 0,
        "yellow_line": 0,
        "red_line": 0,
        "standard": 0,
        "is_available_for_sale": false,
        "prices": []
      }
    ],
    "tax_ids": [
      "string"
    ],
    "discount_ids": [
      "string"
    ],
    "category": {
      "_id": "67b486d242ed76693cd2cc59",
      "name": "string"
    },
    "custom_fields": [
      {
        "_id": "67b486d242ed76693cd2cc59",
        "value": "string"
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

PUT /product/update

This method allows updating product in the account.

Request body

Field	Type	Required	Description
_id	string	No	id of product
name	string	Yes
measure_id	string	Yes	id of measure unit
category_id	string	No	id of product categories
box_type_id	string	No	id of Box type
box_item	number	Yes	number of items that exist in one box. Default: 0
box_item_barcode	string	No	id of box item's barcode
sku	string	Yes	local unique id of product
barcode	string	No	barcode of product
supplier_ids	string[]	No	list of supplier ids
warehouse_number	string	No	Product's location in the warehouse (aisle/shelf/bin label). Optional, free-form.
image	string	No	image path of product that uploaded to the server
materials	object[]	No	list of materials of product. required if is_compound is true
materials[].material_id	string	Yes
materials[].amount	number	Yes
materials[].box_count	integer	No
barcodes	object[]	No	list of barcodes of product
barcodes[].is_active	boolean	No
barcodes[].barcode	string	No
is_semi_product	boolean	Yes	is semi product or not. Default: false
is_product	boolean	Yes	is product or not. Default: false
is_material	boolean	Yes	is material or not. Default: false
dimension	object	No	dimension of product
dimension.shape	string	No	One of: circular, rectangular, other
dimension.netto_weight	number	No
dimension.gross_weight	number	No
dimension.height	number	No
dimension.volume	number	No
dimension.diameter	number	No
dimension.width	number	No
dimension.length	number	No
variants	object[]	No	list of variants of product. required if is_variant is true
variants[]._id	string	Yes
variants[].sku	string	Yes
variants[].barcode	string	No
variants[].image	boolean	No
variants[].organizations	object[]	Yes
variants[].organizations[].organization_id	string	Yes
variants[].organizations[].is_available	boolean	Yes
variants[].organizations[].max_stock	number	No
variants[].organizations[].yellow_line	number	No
variants[].organizations[].red_line	number	No
variants[].organizations[].standard	number	No
variants[].organizations[].is_available_for_sale	boolean	No
variants[].attributes	object[]	Yes
variants[].attributes[].attribute_id	string	Yes
variants[].attributes[].attribute_item_id	string	Yes
organizations	object[]	Yes
organizations[].organization_id	string	Yes
organizations[].is_available	boolean	Yes
organizations[].max_stock	number	No
organizations[].yellow_line	number	No
organizations[].red_line	number	No
organizations[].standard	number	No
organizations[].is_available_for_sale	boolean	No
organizations[].prices	object[]	No	list of prices with optional UOM prices
organizations[].prices[].price_id	string	Yes
organizations[].prices[].amount	number	No
organizations[].prices[].uom_prices	object[]	No

{
  "_id": "string",
  "name": "string",
  "measure_id": "string",
  "category_id": "string",
  "box_type_id": "string",
  "box_item": 0,
  "box_item_barcode": "string",
  "sku": "string",
  "barcode": "string",
  "supplier_ids": [
    "string"
  ],
  "warehouse_number": "string",
  "image": "string",
  "materials": [
    {
      "material_id": "string",
      "amount": 0,
      "box_count": 0
    }
  ],
  "barcodes": [
    {
      "is_active": false,
      "barcode": "string"
    }
  ],
  "is_semi_product": false,
  "is_product": false,
  "is_material": false,
  "dimension": {
    "shape": "circular",
    "netto_weight": 0,
    "gross_weight": 0,
    "height": 0,
    "volume": 0,
    "diameter": 0,
    "width": 0,
    "length": 0
  },
  "variants": [
    {
      "_id": "string",
      "sku": "string",
      "barcode": "string",
      "image": false,
      "organizations": [],
      "attributes": []
    }
  ],
  "organizations": [
    {
      "organization_id": "string",
      "is_available": false,
      "max_stock": 0,
      "yellow_line": 0,
      "red_line": 0,
      "standard": 0,
      "is_available_for_sale": false,
      "prices": []
    }
  ]
}

Response

Same response shape as POST /product/create.

DELETE /product/delete/{id}

Delete a product

Path parameters

Parameter	Type	Required	Description
id	string	Yes

Request body

No request body.

Response

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": "ok",
  "time": "2025-05-01T12:00:00Z"
}

GET /product/get-by-id/{id}

Get product using its _id

Path parameters

Parameter	Type	Required	Description
id	string	Yes

Request body

No request body.

Response

Same response shape as POST /product/create.

POST /product/get-paging

Get products by paging

Request body

Field	Type	Required	Description
page	number	Yes	Default: 1
limit	number	Yes	Default: 20
organization_id	string	No
is_main	boolean	No
category_id	string	No
is_archived	boolean	No
is_compound	boolean	No
is_semi_product	boolean	No
is_product	boolean	No
is_material	boolean	No
updated_at	string	No	ISO time format
is_available_for_sale	boolean	No

{
  "page": 1,
  "limit": 20,
  "organization_id": "string",
  "is_main": false,
  "category_id": "string",
  "is_archived": false,
  "is_compound": false,
  "is_semi_product": false,
  "is_product": false,
  "is_material": false,
  "updated_at": "string",
  "is_available_for_sale": false
}

Response

data.total is the total number of records and data.data[] holds the current page. The table below describes one record.

Field	Type	Description
_id	string	id of product
created_at	string
updated_at	string
name	string
number	string
note	string
box_item	number
box_item_barcode	string
box_type_id	string
box_type	object
box_type._id	string
box_type.code	string
box_type.short_name	string
box_type.name	string
measure	object
measure._id	string
measure.system_code	string
measure.code	string
measure.short_name	string
measure.name	string
measure.decimal_count	number
sku	string
barcode	string
barcodes	object[]	list of barcodes of product
barcodes[].is_active	boolean
barcodes[].barcode	string
supplier_ids	string[]	list of supplier ids
warehouse_number	string	Product's location in the warehouse (aisle/shelf/bin label). Absent when not set.
image	string	image path of product that uploaded to the server
materials	object[]	list of materials of product. required if is_compound is true
materials[].material_id	string
materials[].amount	number
materials[].box_count	integer
materials[].material	object
materials[].material._id	string
materials[].material.name	string
materials[].material.sku	string
is_compound	boolean	is compound product or not
is_marked	boolean	is marked or not
is_product	boolean	is product or not. Default: false
is_material	boolean	is material or not. Default: false
is_semi_product	boolean	is semi product or not. Default: false
dimension	object	dimension of product
dimension.shape	string	One of: circular, rectangular, other
dimension.netto_weight	number
dimension.gross_weight	number
dimension.height	number
dimension.volume	number
dimension.diameter	number
dimension.width	number
dimension.length	number
is_variant	boolean	is variant or not
is_parent	boolean	is parent or not
attributes	object[]
attributes[].attribute_id	string
attributes[].attribute_item_id	string
parent_id	string	id of parent product. it depends on variant product
organizations	object[]
organizations[].organization_id	string
organizations[].is_available	boolean
organizations[].max_stock	number
organizations[].yellow_line	number
organizations[].red_line	number
organizations[].standard	number
organizations[].is_available_for_sale	boolean
organizations[].prices	object[]	list of prices with optional UOM prices
organizations[].prices[].price_id	string
organizations[].prices[].amount	number
organizations[].prices[].uom_prices	object[]
tax_ids	string[]	list of tax ids
discount_ids	string[]	list of discount ids
category	object
category._id	string
category.name	string
custom_fields	object[]
custom_fields[]._id	string
custom_fields[].value	string

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "total": 0,
    "data": [
      {
        "_id": "67b486d242ed76693cd2cc59",
        "created_at": "2023-10-01T12:00:00Z",
        "updated_at": "2023-10-01T12:00:00Z",
        "name": "string",
        "number": "string",
        "note": "string",
        "box_item": 0,
        "box_item_barcode": "string",
        "box_type_id": "67b486d242ed76693cd2cc59",
        "box_type": {
          "_id": "67b486d242ed76693cd2cc59",
          "code": "string",
          "short_name": "string",
          "name": "string"
        },
        "measure": {
          "_id": "67b486d242ed76693cd2cc59",
          "system_code": "string",
          "code": "string",
          "short_name": "string",
          "name": "string",
          "decimal_count": 0
        },
        "sku": "string",
        "barcode": "string",
        "barcodes": [
          {
            "is_active": false,
            "barcode": "string"
          }
        ],
        "supplier_ids": [
          "string"
        ],
        "warehouse_number": "string",
        "image": "string",
        "materials": [
          {
            "material_id": "67b486d242ed76693cd2cc59",
            "amount": 0,
            "box_count": 0,
            "material": {
              "_id": null,
              "name": null,
              "sku": null
            }
          }
        ],
        "is_compound": false,
        "is_marked": false,
        "is_product": false,
        "is_material": false,
        "is_semi_product": false,
        "dimension": {
          "shape": "circular",
          "netto_weight": 0,
          "gross_weight": 0,
          "height": 0,
          "volume": 0,
          "diameter": 0,
          "width": 0,
          "length": 0
        },
        "is_variant": false,
        "is_parent": false,
        "attributes": [
          {
            "attribute_id": "string",
            "attribute_item_id": "string"
          }
        ],
        "parent_id": "67b486d242ed76693cd2cc59",
        "organizations": [
          {
            "organization_id": "67b486d242ed76693cd2cc59",
            "is_available": false,
            "max_stock": 0,
            "yellow_line": 0,
            "red_line": 0,
            "standard": 0,
            "is_available_for_sale": false,
            "prices": []
          }
        ],
        "tax_ids": [
          "string"
        ],
        "discount_ids": [
          "string"
        ],
        "category": {
          "_id": "67b486d242ed76693cd2cc59",
          "name": "string"
        },
        "custom_fields": [
          {
            "_id": "67b486d242ed76693cd2cc59",
            "value": "string"
          }
        ]
      }
    ]
  },
  "time": "2025-05-01T12:00:00Z"
}

GET /product/get-deleted

Get deleted product ids

Query parameters

Parameter	Type	Required	Description
deleted_at	string	Yes

Request body

No request body.

Response

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": [
    "string"
  ],
  "time": "2025-05-01T12:00:00Z"
}

POST /product/get-paging/by-price

Paginated list of products with prices for a specific price list.

Request body

Field	Type	Required	Description
page	number	Yes	Default: 1
limit	number	Yes	Default: 20
price_id	string	Yes	Price list to fetch prices from.
search	string	No
category_ids	string[]	No

{
  "page": 1,
  "limit": 20,
  "price_id": "string",
  "search": "string",
  "category_ids": [
    "string"
  ]
}

Response

Field	Type	Description
list	object[]
list[]._id	string	id of product
list[].created_at	string
list[].updated_at	string
list[].name	string
list[].number	string
list[].note	string
list[].box_item	number
list[].box_item_barcode	string
list[].box_type_id	string
list[].box_type	object
list[].box_type._id	string
list[].box_type.code	string
list[].box_type.short_name	string
list[].box_type.name	string
list[].measure	object
list[].measure._id	string
list[].measure.system_code	string
list[].measure.code	string
list[].measure.short_name	string
list[].measure.name	string
list[].measure.decimal_count	number
list[].sku	string
list[].barcode	string
list[].barcodes	object[]	list of barcodes of product
list[].barcodes[].is_active	boolean
list[].barcodes[].barcode	string
list[].supplier_ids	string[]	list of supplier ids
list[].warehouse_number	string	Product's location in the warehouse (aisle/shelf/bin label). Absent when not set.
list[].image	string	image path of product that uploaded to the server
list[].materials	object[]	list of materials of product. required if is_compound is true
list[].materials[].material_id	string
list[].materials[].amount	number
list[].materials[].box_count	integer
list[].materials[].material	object
list[].is_compound	boolean	is compound product or not
list[].is_marked	boolean	is marked or not
list[].is_product	boolean	is product or not. Default: false
list[].is_material	boolean	is material or not. Default: false
list[].is_semi_product	boolean	is semi product or not. Default: false
list[].dimension	object	dimension of product
list[].dimension.shape	string	One of: circular, rectangular, other
list[].dimension.netto_weight	number
list[].dimension.gross_weight	number
list[].dimension.height	number
list[].dimension.volume	number
list[].dimension.diameter	number
list[].dimension.width	number
list[].dimension.length	number
list[].is_variant	boolean	is variant or not
list[].is_parent	boolean	is parent or not
list[].attributes	object[]
list[].attributes[].attribute_id	string
list[].attributes[].attribute_item_id	string
list[].parent_id	string	id of parent product. it depends on variant product
list[].organizations	object[]
list[].organizations[].organization_id	string
list[].organizations[].is_available	boolean
list[].organizations[].max_stock	number
list[].organizations[].yellow_line	number
list[].organizations[].red_line	number
list[].organizations[].standard	number
list[].organizations[].is_available_for_sale	boolean
list[].organizations[].prices	object[]	list of prices with optional UOM prices
list[].tax_ids	string[]	list of tax ids
list[].discount_ids	string[]	list of discount ids
list[].category	object
list[].category._id	string
list[].category.name	string
list[].custom_fields	object[]
list[].custom_fields[]._id	string
list[].custom_fields[].value	string
total	number

{
  "code": 0,
  "message": "Success",
  "status_code": 200,
  "data": {
    "list": [
      {
        "_id": "67b486d242ed76693cd2cc59",
        "created_at": "2023-10-01T12:00:00Z",
        "updated_at": "2023-10-01T12:00:00Z",
        "name": "string",
        "number": "string",
        "note": "string",
        "box_item": 0,
        "box_item_barcode": "string",
        "box_type_id": "67b486d242ed76693cd2cc59",
        "box_type": {
          "_id": null,
          "code": null,
          "short_name": null,
          "name": null
        },
        "measure": {
          "_id": null,
          "system_code": null,
          "code": null,
          "short_name": null,
          "name": null,
          "decimal_count": null
        },
        "sku": "string",
        "barcode": "string",
        "barcodes": [],
        "supplier_ids": [],
        "warehouse_number": "string",
        "image": "string",
        "materials": [],
        "is_compound": false,
        "is_marked": false,
        "is_product": false,
        "is_material": false,
        "is_semi_product": false,
        "dimension": {
          "shape": null,
          "netto_weight": null,
          "gross_weight": null,
          "height": null,
          "volume": null,
          "diameter": null,
          "width": null,
          "length": null
        },
        "is_variant": false,
        "is_parent": false,
        "attributes": [],
        "parent_id": "67b486d242ed76693cd2cc59",
        "organizations": [],
        "tax_ids": [],
        "discount_ids": [],
        "category": {
          "_id": null,
          "name": null
        },
        "custom_fields": []
      }
    ],
    "total": 0
  },
  "time": "2025-05-01T12:00:00Z"
}

POST /product/get-by-name

Find a product by its exact name.

Request body

Field	Type	Required	Description
name	string	Yes

{
  "name": "string"
}

Response

Same response shape as POST /product/create.

POST /product/get-by-barcode

Find a product by its barcode within an organization.

Request body

Field	Type	Required	Description
barcode	string	Yes	barcode of product to look up
organization_id	string	Yes	organization ObjectId to scope the lookup

{
  "barcode": "string",
  "organization_id": "string"
}

Response

Same response shape as POST /product/create.

POST /product/get-by-sku

Find a product by its SKU within an organization.

Request body

Field	Type	Required	Description
sku	string	Yes	local unique id (SKU) of product to look up
organization_id	string	Yes	organization ObjectId to scope the lookup

{
  "sku": "string",
  "organization_id": "string"
}

Response

Same response shape as POST /product/create.

POST /product/delete-many

Soft-delete multiple products by their ObjectIds. Each product is marked is_deleted=true; no physical deletion occurs. Products that are currently in stock, in transit, on-the-way, or booked cannot be deleted and will return an error.

Request body

Field	Type	Required	Description
ids	string[]	Yes	List of product ObjectIds to soft-delete

{
  "ids": [
    "string"
  ]
}

Response

Same response shape as GET /product/get-deleted.

POST /product/update-status-many

Archive or unarchive multiple products by their ObjectIds. Set is_archived=true to archive, false to unarchive. Archived products remain visible but are excluded from active product lookups by default.

Request body

Field	Type	Required	Description
ids	string[]	Yes	List of product ObjectIds to archive or unarchive
is_archived	boolean	No	true to archive the products, false to unarchive them. Defaults to true when omitted.

{
  "ids": [
    "string"
  ],
  "is_archived": false
}

Response

Same response shape as GET /product/get-deleted.

---

This page is generated from the OpenAPI spec.