Create Box

POST

https://{tenant_name}.benchling.com/api/v3/box

POST

/api/v3/box

curl -X POST https://{tenant_name}.benchling.com/api/v3/box \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "schemaId": "schemaId"
}'

{
  "__typename": "__typename",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "archiveReason": "archiveReason",
  "archived": true,
  "availableCapacity": 1,
  "barcode": "barcode",
  "createdAt": "createdAt",
  "emptyContainers": 1,
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "occupiedCapacity": 1,
  "parentStorage": {
    "__typename": "__typename",
    "id": "id"
  },
  "project": {
    "__typename": "__typename",
    "id": "id"
  },
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "totalCapacity": 1
}

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

creatorobject or nullOptional

schemaFieldslist of objects or nullOptional

archiveReasonstring or nullOptional

archivedbooleanOptional

availableCapacityintegerOptional

The number of available positions in the box.

barcodestring or nullOptional

createdAtstring or nullOptional

emptyContainersinteger or nullOptional

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

idstringOptional

modifiedAtstring or nullOptional

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).

Errors

400

Box Create Request Bad Request Error

403

Box Create Request Forbidden Error

404

Box Create Request Not Found Error

409

Box Create Request Conflict Error

429

Box Create Request Too Many Requests Error

500

Box Create Request Internal Server Error