Create an object

Body Params

Shared validation and save logic for item_units_of_measure across v1 and v2 serializers.

string
enum

How an assembly item is fulfilled: BUILD (manufactured to stock, must be inventory-tracked) or KIT (components consumed when sold, must not be inventory-tracked). Only meaningful when is_assembly is true.

  • BUILD - Manufactured (build to stock)
  • KIT - Kit (assembled on sale)
Allowed:
bill_of_materials

The bill of materials to set on an assembly item. Requires is_assembly. Replaces the current bill of materials; when it is already referenced by a posted document, a new revision is created instead.

defaults
object

The defaults of the item.

description
object

The description of the item.

boolean

The indicator if the warehouse is active or not.

boolean

The indicator if the item is an assembly (built from other items via a bill of materials).

boolean

The indicator if the account of the item is tracked inventory or not.

item_units_of_measure
array of objects

The units of measure for this item.

item_units_of_measure
name
object
required

The name of the item.

uri | null

The photo of the item.

quantity_operand_custom_field_ids
array of strings | null

The quantity formula operands: ids of line-item custom fields (type NUMBER or CALCULATED) and/or numeric constants whose product drives the quantity of line items referencing this item. Requires the Advanced Customization add-on. Empty/null clears the formula.

quantity_operand_custom_field_ids
string
length ≤ 200
double | null
string | null

Deprecated. Sets the base unit of measure. Use item_units_of_measure instead.

double | null
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Response

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