Withdraw a catalog for good

POST /catalogs/{catalogId}/archive

History stays readable; every view still assigned to it sees an empty catalog. Idempotent. Appends inventory.catalog-archived; a retry appends nothing.

Access

Requires catalogs:write.

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

Retries

Appends inventory.catalog-archived; a retry appends nothing.

A retry with the same key answers 200, with what the first call recorded.

Why every write carries a key: Idempotency and retries.

Facts appended

inventory.catalog-archived

What a fact is: Facts and the journal.

AI agent tool

Agents call this as catalog_archive_catalog (Catalog: Archive catalog), in the catalog toolset.

Connecting an agent: AI agents.

Example

curl

curl -X POST 'https://inventory.getmanifold.io/catalogs/cat_019e394f-ed80-7da2-823a-3ff13eb84f30/archive' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://inventory.getmanifold.io/catalogs/cat_019e394f-ed80-7da2-823a-3ff13eb84f30/archive", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Response · 200 · application/json

{
  "id": "cat_019e394f-ed80-7da2-823a-3ff13eb84f30",
  "name": "Wholesale",
  "currency": "AUD",
  "status": "archived",
  "productCount": 2,
  "priceCount": 0,
  "pricing": {
    "_tag": "auto",
    "base": {
      "_tag": "catalog",
      "catalogId": "cat_019cadd3-8524-7934-9ee3-29b896f71f80"
    },
    "adjustment": {
      "_tag": "discount",
      "basisPoints": 3000
    },
    "rounding": [
      {
        "fromCents": 0,
        "stepCents": 100,
        "endingCents": 95
      }
    ]
  },
  "taxInclusive": "exclusive",
  "createdAt": "2026-05-18T04:20:00.000Z",
  "updatedAt": "2026-10-22T08:05:00.000Z"
}

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: inventory-manager.openapi.json. Base URL https://inventory.getmanifold.io.

Errors

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

`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
`CatalogNotFound` catalogId	No such record in this organization.	Check the id in the path or the body.

`409`

Refusal	What it means	What to do
`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.

`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, with the same key.

How refusals work everywhere: Errors.