Location

Create Location

Create Location.

post/api/v3/location

Request

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

Request body

barcodestring
namestring required
parentStorageIdstring
schemaFieldsobject
schemaIdstring required

Response

Created

__typenamestring
allowNonLocationChildrenboolean

Whether this location can store plates, boxes, and containers.

archiveReasonstring nullable
archivedboolean
availableCapacityinteger nullable

The number of available positions in this location. Null if totalCapacity is not set.

barcodestring nullable
createdAtstring datetime nullable
idstring
modifiedAtstring datetime nullable
namestring nullable
occupiedCapacityinteger nullable

The number of plates, boxes, and containers currently in this location. Null if totalCapacity is not set.

totalCapacityinteger nullable

The total capacity of this location (i.e. how many plates, boxes, and containers it can store). If null, capacity is not limited.

validationStatus'PASSED' | 'FAILED'

Whether this location is passing all validation checks.

Changes

No recorded changes to this operation across all 2 revisions of this API.