Create stock item

post

https://api.mrpeasy.com/rest/v2/items

Create a stock item and return its product ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

title

string

required

Name or description of the item.

code

string | null

Defaults to null

A unique part number to identify the item. If omitted, the system generates one according to numbering settings.

unit_id

integer | null

Defaults to null

ID of the unit of measurement.

group_id

integer | null

Defaults to null

ID of the product group.

is_raw

boolean

Defaults to false

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

not_for_sale

boolean

Defaults to false

Shows if this item is not for sale.

is_inventory

boolean

Defaults to true

Shows whether this is an inventory item.

standalone_mo

boolean

Defaults to false

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

min_manufacturing_quantity

string | null

Defaults to null

Minimum manufacturing order quantity. Decimal number as a string.

selling_price

string | null

Defaults to null

Selling price per unit.

min_quantity

Minimum stock quantity threshold per site. Can be a single decimal value applied to all sites, or an array of per-site quantities.

location_id

Default storage location. Can be a single integer location ID applied to the default site, or an array of per-site locations.

barcode

string | null

Defaults to null

Barcode of the item (if "Barcodes" functionality is enabled).

weight

string | null

Defaults to null

Weight of the item (if "Packing" functionality is enabled). Decimal number as a string.

weight_unit_id

integer | null

enum

Defaults to null

ID of weight unit (if "Packing" functionality is enabled).

1 - g
2 - oz
3 - lbs
4 - kg

Allowed:

revision

string | null

Defaults to null

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

quality_control

boolean

Defaults to false

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

onhold_period

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).

serials

boolean

Defaults to false

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

shelf_life

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.

custom_values

Responses

401

Unauthorized

429

Too many requests

201Stock item created

422Validation error