Partial update an object

patch

https://api.wafeq.com/v2/items/{id}/

Partially update an item.

Path Params

string

required

Body Params

The payload to create or update an item.

assembly_fulfillment

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.

View the enum reference

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.

is_active

boolean

The indicator if the item is active or not.

is_assembly

boolean

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

is_tracked_inventory

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

The name of the item.

photo

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

sku

string

length ≤ 200

The stock keeping unit (SKU) of the item.

unit_cost

double | null

The cost of the item.

unit_of_measure

string | null

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

unit_price

double | null

The price of the item.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response