BEbenchling
boxes

Update a box

Update a box

patch/boxes/{box_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com/api/v2
  • Auth
    HTTP bearer

Path parameters

box_idstring required

Request body

fieldsFields
namestring
parentStorageIdstring
projectIdstring

Response

OK

availableCapacityinteger

The number of available positions in the box.

barcodestring nullable
createdAtstring date-time
emptyContainersinteger

The number of containers in the box that have no contents.

emptyPositionsinteger

The number of empty positions for adding additional containers in the box.

fieldsFields
filledPositionsinteger

The number of containers currently in the box.

idstring
modifiedAtstring date-time
namestring
occupiedCapacityinteger

The number of containers currently in the box.

parentStorageIdstring nullable
projectIdstring nullable
sizeinteger

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

totalCapacityinteger

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

webURLstring

Changes

No recorded changes to this operation across all 1 revision of this API.