Skip to main content
POST
Error

Authorizations

​
Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Body

application/json

Request to create an asset (inventory item)

​
condition
enum<string>
required

Condition of the asset.

Available options:
NEW,
USED_LIKE_NEW,
USED_GOOD,
USED_FAIR,
USED,
USED_POOR,
UNUSABLE
Example:

"NEW"

​
sku_id
string<uuid>

SKU ID for known products. Mutually exclusive with category_code+description.

Example:

"ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4"

​
category_code
string

Category code for custom/legacy products. Mutually exclusive with sku_id.

Example:

"LAPTOP"

​
brand_code
string

Brand code. Optional, used with category_code. Accepts legacy vendor_code.

Example:

"APPLE"

​
brand_id
string<uuid>

Brand ID. Optional alternative to brand_code. Accepts legacy vendor_id.

Example:

"ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4"

​
description
string

Product description. Required when category_code is provided.

Example:

"MacBook Pro 14\" M3"

​
serial_number
string

Serial number of the asset.

Example:

"C02ZX1ABCDEF"

​
renewal_date
string<date>

Renewal date for the asset. Defaults to a calculated date based on the organization's refresh policy if not provided.

Example:

"2027-01-15"

​
person_id
string<uuid>

Person ID to assign the asset to. Mutually exclusive with office_id.

Example:

"ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4"

​
office_id
string<uuid>

Office ID to assign the asset to. Mutually exclusive with person_slug.

Example:

"ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4"

Response

Asset created

Newly created inventory asset item response

​
id
string<uuid>
required

Unique identifier for the created inventory item

Example:

"ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4"

​
sku_id
string<uuid>

ID of the SKU (product variant) this item is associated with; null for custom/generic assets

Example:

"ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4"

​
brand_code
string

Brand code of the SKU vendor; null when the asset has no associated SKU vendor

Example:

"APPLE_US"

​
serial_number
string

Hardware serial number of the device; null when not provided at creation

Example:

"C02ZX1ABCDEF"

​
condition
enum<string>

Physical condition of the item at creation time (NEW or USED)

Available options:
NEW,
USED_LIKE_NEW,
USED_GOOD,
USED_FAIR,
USED,
USED_POOR,
UNUSABLE
Example:

"NEW"

​
deploy_status
enum<string>

Current lifecycle state of the item after creation (typically DEPLOYED when assigned to a person, AVAILABLE when assigned to an office)

Available options:
ARCHIVED,
AVAILABLE,
AWAITING_ARRIVAL,
DEPLOYED,
GIFTED,
LOCKED,
ON_HOLD,
OUT_FOR_REPAIR,
UNAVAILABLE,
VOIDED
Example:

"DEPLOYED"

​
description
string

Free-text product description; populated for custom/generic SKUs when sku_id is null

Example:

"MacBook Pro 14\" M3"

​
renewal_date
string<date>

Date when this item is scheduled for renewal or replacement

Example:

"2027-01-15"

​
person_id
string<uuid>

ID of the person this item is assigned to; null when assigned to an office

Example:

"ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4"

​
office_id
string<uuid>

ID of the office this item is assigned to; null when assigned to a person

Example:

"ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4"

​
created_at
string<date-time>

Timestamp (UTC) when this inventory item was created

Example:

"2024-01-15T10:30:00Z"

​
apple_business
object

Apple Business Manager assignment for serialized Apple assets. Omitted for non-Apple or non-serialized items.