Update stock item

Replace all editable fields of a stock item by product ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Stock item product_id.

Body Params
string
required

Name or description of the item.

string
required

A part number of the stock item.

boolean
required

Shows if this is a raw material that is bought from vendors.

boolean
required

Shows if this item is not for sale.

boolean | null
required

Shows whether this item's MOs should be separate from the nested multi-level MOs of the top-level product.

integer | null
Defaults to null

ID of the unit of measurement.

integer | null
Defaults to null

ID of the product group.

location_id
array of objects | null
Defaults to null

Default storage location per site. An array replaces the whole collection: a site that is not listed is cleared, and an empty array clears every site.

location_id
string | null
Defaults to null

Selling price per unit.

Minimum stock quantity threshold per site. An array replaces the whole collection: a site that is not listed is cleared, and an empty array clears every site. A single decimal value applies to the main site (site_id 1) and clears the other sites.

string | null
Defaults to null

Minimum manufacturing order quantity. Decimal number as a string.

string | null
Defaults to null

Barcode of the item (if Barcodes functionality is enabled). Use this property only when the item has no parameters. Otherwise, update the specific variation instead.

string | null
Defaults to null

Weight of the item. Decimal number as a string.

integer | null
enum
Defaults to null

ID of weight unit.

  • 1 - g
  • 2 - oz
  • 3 - lbs
  • 4 - kg
Allowed:
string | null
Defaults to null

Revision of the stock item (if "Version Control System" is enabled).

boolean | null
Defaults to null

Shows whether this item has serial numbers (if "Serial Numbers" is enabled).

boolean | null
Defaults to null

Shows whether this item must pass quality inspection when received (if "Quality Control" is enabled).

integer | null
Defaults to null

The number of days the goods will be on hold for quality inspection (if "Quality Control" is enabled and "quality_control" is true).

integer | null
Defaults to null

The number of days before the goods expire (if "Version Control System" is enabled).

custom_values
array of objects | null
Defaults to null

Custom values. Values that are missing in the array, will be deleted.

custom_values
files
array of objects | null
Defaults to null

Files of the item. The array replaces the current collection: a file that is not listed is removed. Omit the property to leave the files unchanged.

files
Responses
202

Stock item updated

401

Unauthorized

404

Not found

429

Too many requests

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json