Inventory Manager API · products

Withdraw a product from sale for good

POST /products/{productId}/archive

Its variants and their SKUs stay readable and keep answering availability; nothing about the product can change afterwards. Appends inventory.product-archived. Archiving twice is acknowledged. A retry appends nothing.

Access

Requires products:write.

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

Retries

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.product-archived

What a fact is: Facts and the journal.

AI agent tool

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

Connecting an agent: AI agents.

Example

curl
curl -X POST 'https://inventory.getmanifold.io/products/prd_019d4cb8-c230-7235-aee3-dcb05170df0e/archive' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"
JavaScript (fetch)
const response = await fetch("https://inventory.getmanifold.io/products/prd_019d4cb8-c230-7235-aee3-dcb05170df0e/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": "prd_019d4cb8-c230-7235-aee3-dcb05170df0e",
  "title": "Widget twin pack",
  "description": "One blue and one red widget in a gift box.",
  "status": "archived",
  "handle": "widget-twin-pack",
  "vendor": "Tidewater Supply Co.",
  "productType": "Widgets",
  "tags": [
    "Hardware",
    "Gift"
  ],
  "taxClass": "standard",
  "options": [],
  "variants": [
    {
      "id": "var_019d4cb8-c618-7383-84f4-8228073621c6",
      "sku": "WIDGET-PAIR",
      "options": [],
      "kind": {
        "_tag": "composite",
        "components": [
          {
            "sku": "WIDGET-BLUE",
            "quantity": 1
          },
          {
            "sku": "WIDGET-RED",
            "quantity": 1
          }
        ],
        "barcodes": [
          {
            "value": "9300000000033",
            "type": "gtin"
          }
        ],
        "hsCodes": [],
        "weightGrams": 500,
        "packedSize": {
          "lengthMm": 160,
          "widthMm": 120,
          "heightMm": 60
        }
      },
      "createdAt": "2026-04-02T05:44:30.000Z",
      "updatedAt": "2026-04-02T05:44:30.000Z"
    }
  ],
  "createdAt": "2026-04-02T05:44:30.000Z",
  "updatedAt": "2026-10-22T07:10: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

RefusalWhat it meansWhat 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

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

403

RefusalWhat it meansWhat 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

RefusalWhat it meansWhat to do
ProductNotFound productId No such record in this organization.Check the id in the path or the body.

409

RefusalWhat it meansWhat 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

RefusalWhat it meansWhat 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.