Add a box to the catalogue

PUT /boxes/{boxId}

Add a box to the catalogue, or replace one (restoring it, when it was archived): its name, inner size, tare and maximum weight, packaging, and the sites that stock it — all, or a listed set.

400 BoxPackagingInvalid for item packaging (goods in their own packaging are no box); 404 LocationNotFound or 409 LocationNotFulfillable for a listed site the organization does not ship from. Appends fulfillment.box-saved. Idempotent by content: the box as it already stands appends nothing.

Access

Requires shipping:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: the box as it already stands appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

fulfillment.box-saved

What a fact is: Facts and the journal.

AI agent tool

Agents call this as fulfillment_save_box (Fulfillment: Save box), in the parcels toolset.

Connecting an agent: AI agents.

Example

curl

curl -X PUT 'https://fulfillment.getmanifold.io/boxes/box_01a0f6b4-3e10-7aa1-8c24-2c3d4e5f6071' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Mailer box",
  "inner": {
    "lengthMm": 260,
    "widthMm": 210,
    "heightMm": 120
  },
  "tareGrams": 180,
  "maxWeightGrams": 10000,
  "packaging": "carton",
  "sites": {
    "_tag": "all"
  }
}'

JavaScript (fetch)

const response = await fetch("https://fulfillment.getmanifold.io/boxes/box_01a0f6b4-3e10-7aa1-8c24-2c3d4e5f6071", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "name": "Mailer box",
    "inner": {
      "lengthMm": 260,
      "widthMm": 210,
      "heightMm": 120
    },
    "tareGrams": 180,
    "maxWeightGrams": 10000,
    "packaging": "carton",
    "sites": {
      "_tag": "all"
    }
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "name": "Mailer box",
  "inner": {
    "lengthMm": 260,
    "widthMm": 210,
    "heightMm": 120
  },
  "tareGrams": 180,
  "maxWeightGrams": 10000,
  "packaging": "carton",
  "sites": {
    "_tag": "all"
  }
}

Response · 200 · application/json

{
  "id": "box_01a0f6b4-3e10-7aa1-8c24-2c3d4e5f6071",
  "name": "Mailer box",
  "inner": {
    "lengthMm": 260,
    "widthMm": 210,
    "heightMm": 120
  },
  "tareGrams": 180,
  "maxWeightGrams": 10000,
  "packaging": "carton",
  "sites": {
    "_tag": "all"
  },
  "archived": false,
  "createdAt": "2026-10-14T23:02:10.400Z",
  "updatedAt": "2026-10-14T23:02:10.400Z"
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: fulfillment-manager.openapi.json. Base URL https://fulfillment.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`400`

Refusal	What it means	What to do
`BoxPackagingInvalid` packaging, reason	A box needs a packaging kind other than `item`.	Choose carton, satchel or another box kind.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`404`

Refusal	What it means	What to do
`LocationNotFound` locationId	No such record in this organization.	Check the id in the path or the body.

`409`

Refusal	What it means	What to do
`LocationNotFulfillable` locationId	The organization does not ship from this location.	Choose a location that ships, or set this one to ship.
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`502`

Refusal	What it means	What to do
`InventoryUnavailable` reason	The inventory service did not answer, so nothing changed.	Send the same request again shortly.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Send the same request again shortly.

How refusals work everywhere: Errors.

Used in

Pack parcels into your boxes, step 3: Add a box
Pack parcels into your boxes, step 4: Save it again