Skip to main content
POST
Create one or more items

Authorizations

X-API-Key
string
header
required

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

Body

application/json
name
string
required
sku
string
required
id
string<uuid>

Optional client-supplied ID.

isArchived
boolean
identifier
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.

value
object
required