Skip to main content
PATCH
Update matching items

Authorizations

X-API-Key
string
header
required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Query Parameters

Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.

filter
string

AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.

Body

application/json
isArchived
boolean
name
string
identifier
string
sku
string
description
string | null
category
string | null
type
enum<string>
Available options:
raw_material,
purchased,
manufactured
status
enum<string> | null
Available options:
design,
active,
obsolete
isConsumable
boolean
shipLoose
boolean
trackedOnly
boolean
baseUnitMeasureId
string<uuid> | null
purchaseUnitMeasureId
string<uuid> | null
unitsPerPurchase
number | null
stockLength
number | null
defaultLocationId
string<uuid> | null
parentItemId
string<uuid> | null
trackingMode
enum<string>
Available options:
aggregate,
piece,
lot
minQuantity
number | null
maxQuantity
number | null
unitCost
number | null
metadata
object

Response

Successful response.

values
object[]