Skip to navigation
v2Boxes

Create a box

Create a box

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
schemaIdstringRequired
barcodestringOptional
fieldsmap from strings to objectsOptional
namestringOptional
parentStorageIdstringOptional
projectIdstringOptional

Response

Created
archiveRecordobject or nullOptional
availableCapacityintegerOptionalRead-only
The number of available positions in the box.
barcodestring or nullOptional
createdAtdatetimeOptionalRead-only
creatorobjectOptional
emptyContainersintegerOptionalRead-only
The number of containers in the box that have no contents.
emptyPositionsintegerOptionalRead-only
The number of empty positions for adding additional containers in the box.
fieldsmap from strings to objectsOptional
filledPositionsintegerOptionalRead-only
The number of containers currently in the box.
idstringOptional
modifiedAtdatetimeOptionalRead-only
namestringOptional
occupiedCapacityintegerOptionalRead-only
The number of containers currently in the box.
parentStorageIdstring or nullOptional
projectIdstring or nullOptional
schemaobject or nullOptional
sizeintegerOptionalRead-only

The size of the box (i.e. how many containers it can store).

totalCapacityintegerOptionalRead-only

The total capacity of the box (i.e. how many containers it can store).

webURLstringOptionalRead-only

Errors

400
Bad Request Error