Inventory Manager API · products

Retitle or re-describe a product

PATCH /products/{productId}

Retitle or re-describe a product, move it between active and draft, or set its metadata — handle, vendor, productType, category, tags, seo, the fields a storefront's product carries.

Metadata is a patch: an absent field is left alone, null clears it, a value replaces it, and tags is replaced whole. A handle cannot be cleared, and one another product holds is suffixed (-2, -3, …) rather than refused — read it back. Appends inventory.product-updated. 409 ProductArchived once archived. Idempotent by content: a retry that changes nothing is acknowledged and appends nothing.

Access

Requires products:write.

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

Retries

Idempotent by content: a retry that changes nothing is acknowledged and appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

  • inventory.product-updated

What a fact is: Facts and the journal.

AI agent tool

Agents call this as catalog_update_product (Catalog: Update product), in the catalog toolset.

Connecting an agent: AI agents.

Example

Retag the product and give it a search description.

curl
curl -X PATCH 'https://inventory.getmanifold.io/products/prd_019cd54b-2e40-7921-ac50-698c7db3cbeb' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "tags": [
    "Hardware",
    "Bestseller",
    "Kitchen"
  ],
  "seo": {
    "title": "Widget — moulded, dishwasher safe",
    "description": "A moulded widget for everyday fixing jobs, in blue or red."
  }
}'
JavaScript (fetch)
const response = await fetch("https://inventory.getmanifold.io/products/prd_019cd54b-2e40-7921-ac50-698c7db3cbeb", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "tags": [
      "Hardware",
      "Bestseller",
      "Kitchen"
    ],
    "seo": {
      "title": "Widget — moulded, dishwasher safe",
      "description": "A moulded widget for everyday fixing jobs, in blue or red."
    }
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Request body · application/json
{
  "tags": [
    "Hardware",
    "Bestseller",
    "Kitchen"
  ],
  "seo": {
    "title": "Widget — moulded, dishwasher safe",
    "description": "A moulded widget for everyday fixing jobs, in blue or red."
  }
}
Response · 200 · application/json
{
  "id": "prd_019cd54b-2e40-7921-ac50-698c7db3cbeb",
  "title": "Widget",
  "description": "A moulded widget for everyday fixing jobs. Dishwasher safe.",
  "status": "active",
  "handle": "widget",
  "vendor": "Tidewater Supply Co.",
  "productType": "Widgets",
  "tags": [
    "Hardware",
    "Bestseller",
    "Kitchen"
  ],
  "seo": {
    "title": "Widget — moulded, dishwasher safe",
    "description": "A moulded widget for everyday fixing jobs, in blue or red."
  },
  "taxClass": "standard",
  "options": [
    {
      "name": "Colour",
      "values": [
        "Blue",
        "Red"
      ]
    }
  ],
  "variants": [
    {
      "id": "var_019cd54b-2e4a-7ee1-b04a-3bb14b60736f",
      "sku": "WIDGET-BLUE",
      "options": [
        {
          "name": "Colour",
          "value": "Blue"
        }
      ],
      "kind": {
        "_tag": "stocked"
      },
      "createdAt": "2026-03-10T01:10:00.000Z",
      "updatedAt": "2026-03-10T01:10:00.000Z"
    },
    {
      "id": "var_019cd54b-2e54-72b7-ae20-2d04347601b0",
      "sku": "WIDGET-RED",
      "options": [
        {
          "name": "Colour",
          "value": "Red"
        }
      ],
      "kind": {
        "_tag": "stocked"
      },
      "createdAt": "2026-03-10T01:10:00.000Z",
      "updatedAt": "2026-03-10T01:10:00.000Z"
    }
  ],
  "createdAt": "2026-03-10T01:10:00.000Z",
  "updatedAt": "2026-10-22T07:00: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
ProductArchived productId The product is archived, and an archived product takes no changes.Use a product that is not archived.
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 shortly.

How refusals work everywhere: Errors.