Skip to navigation

Create Box

Create Box.

Authentication

AuthorizationBearer

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

Request

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

Response

Created
__typenamestringOptional
archiveReasonstring or nullOptional
archivedbooleanOptional
availableCapacityintegerOptional
The number of available positions in the box.
barcodestring or nullOptional
createdAtstring or nullOptionalformat: "datetime"
emptyContainersinteger or nullOptional
The number of containers in the box that have no contents.
idstringOptional
modifiedAtstring or nullOptionalformat: "datetime"
namestring or nullOptional
occupiedCapacityintegerOptional
The number of containers currently in the box.
parentStorageobject or nullOptional
projectobject or nullOptional
schemaobject or nullOptional
totalCapacityintegerOptional

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

creatorobject or nullOptional
schemaFieldslist of objects or nullOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error