Inventory Manager API · products

Change a variant's title

PATCH /products/{productId}/variants/{variantId}

Change a variant's title, its option selection, or — for a kit (composite) — its recipe (components), trade codes (409 BarcodeConflict), measurements and order rules (null clears); those on a stocked variant are 409 VariantNotComposite, being its item's.

The SKU is not editable: a new SKU is a new variant. Appends inventory.variant-updated. 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.variant-updated

What a fact is: Facts and the journal.

AI agent tool

Agents call this as catalog_update_variant (Catalog: Update variant), in the catalog toolset.

Connecting an agent: AI agents.

Example

Name the kit's variant and correct its packed weight.

curl
curl -X PATCH 'https://inventory.getmanifold.io/products/prd_019d4cb8-c230-7235-aee3-dcb05170df0e/variants/var_019d4cb8-c618-7383-84f4-8228073621c6' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "Twin pack",
  "weightGrams": 520
}'
JavaScript (fetch)
const response = await fetch("https://inventory.getmanifold.io/products/prd_019d4cb8-c230-7235-aee3-dcb05170df0e/variants/var_019d4cb8-c618-7383-84f4-8228073621c6", {
  method: "PATCH",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "title": "Twin pack",
    "weightGrams": 520
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Request body · application/json
{
  "title": "Twin pack",
  "weightGrams": 520
}
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": "active",
  "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",
      "title": "Twin pack",
      "options": [],
      "kind": {
        "_tag": "composite",
        "components": [
          {
            "sku": "WIDGET-BLUE",
            "quantity": 1
          },
          {
            "sku": "WIDGET-RED",
            "quantity": 1
          }
        ],
        "barcodes": [
          {
            "value": "9300000000033",
            "type": "gtin"
          }
        ],
        "hsCodes": [],
        "weightGrams": 520,
        "packedSize": {
          "lengthMm": 160,
          "widthMm": 120,
          "heightMm": 60
        }
      },
      "createdAt": "2026-04-02T05:44:30.000Z",
      "updatedAt": "2026-10-22T07:20:00.000Z"
    }
  ],
  "createdAt": "2026-04-02T05:44:30.000Z",
  "updatedAt": "2026-10-22T07:20: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.
VariantNotFound sku 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.
VariantOptionsInvalid productId, sku, reason The variant's options do not fit the product's options. reason says how.Send an option value for each of the product's options.
VariantNotComposite sku The SKU is not a kit, so it has no recipe.Check the SKU.
SkuNotStocked sku The SKU is not stocked: it is a service or a kit, which holds no units.Use a stocked SKU.
BarcodeConflict barcode, sku Another SKU already has this barcode. sku names it.Use another barcode, or take it off the other SKU first.
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.