Box

Update Box.

patch/api/v3/box/{box_id}

Request

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

Path parameters

box_idstring required

ID of the Box.

Request body

archiveReasonstring

Why it is being archived. Required when archived is true, and not allowed when unarchiving.

archivedboolean

Set to true to archive or false to unarchive it. Archiving requires archiveReason.

barcodestring
namestring
parentStorageIdstring nullable
projectIdstring nullable
schemaFieldsobject
shouldRemoveBarcodesboolean

Whether to remove the barcodes of the box and of every container archived with it. Only allowed when archiving the box, and can't be combined with barcode.

Response

OK

__typenamestring
archiveReasonstring nullable
archivedboolean
availableCapacityinteger

The number of available positions in the box.

barcodestring nullable
createdAtstring datetime nullable
emptyContainersinteger nullable

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

idstring
modifiedAtstring datetime nullable
namestring nullable
occupiedCapacityinteger

The number of containers currently in the box.

totalCapacityinteger

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

Changes