---
title: "Archive boxes"
method: POST
path: "/boxes:archive"
tags: ["boxes"]
---

# Archive boxes

`POST /boxes:archive`

## Request

- Base URL: `https://{tenant_name}.benchling.com/api/v2`
- URL: `https://{tenant_name}.benchling.com/api/v2/boxes:archive`
- Auth: HTTP bearer

Archive boxes and any containers of the boxes

## Request body

- BoxesArchive
  - `boxIds` string[], required: Array of box IDs
  - `reason` 'Made in error' | 'Retired' | 'Expended' | 'Shipped' | 'Contaminated' | 'Expired' | 'Missing' | 'Other', required: Reason that boxes are being archived.
  - `shouldRemoveBarcodes` boolean: Remove barcodes. Removing barcodes from archived inventory that contain items will also remove barcodes from the contained items.

## Response `200`

OK

- BoxesArchivalChange: IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of boxes along with any IDs of containers that were archived / unarchived.
  - `boxIds` string[]
  - `containerIds` string[]

## Other responses

- `403`: Forbidden

---

[API](https://skmtc.dev/benchling/apis/benchling-api-2.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api-2/revisions/01d2fa8523cd?raw)