Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

slug
string
required

Response

Package duplicated

Package details returned by get/list package endpoints

id
string<uuid>
required

Unique identifier of the package

name
string
required

Display name of the package.

automaticOrder
boolean
required

When true, assigning this package can trigger automatic equipment ordering

approvalRequired
boolean
required

When true, orders from this package require admin approval

requireJustification
boolean
required

When true, requesters must provide a justification when ordering

slug
string
required

URL-safe unique identifier for the package

active
boolean
required

Whether the package is active

notes
object[]
required

Notes associated with the package

regions
object[]
required

Regions stored on this package. Persisted in package_region rows and maintained when the package's SKU lines change — not derived at read time.

skuLines
object[]
required

Category SKU lines with per-SKU region scoping

rules
object[]
required

Category quantity rules for the package

bundleLines
object[]
required

Bundle references attached to this package

usedEquipmentPreferences
object[]
required

Used-equipment preferences per category

skuIds
string<uuid>[]

SKU UUIDs included in this package

assignedTo
object

People currently assigned to this package

deliverySetting
enum<string>

Where package equipment should be delivered

Available options:
PERSON,
OFFICE,
FLEXIBLE
defaultOfficeId
string<uuid>

Default office UUID used when the delivery setting targets an office