VX Agents

API directory · Commerce & Payments

Katana Manufacturing Orders & BOMs

v1.0.0 · 14 endpoints · 0 connections · shared by vx.ai

What is on the shop floor today, and what is blocked? For makers on Katana MRP: open manufacturing orders (or make-to-order ones from a sales order row), check ingredient rows and BOMs, tick off operation steps and record partial productions as batches come off the line.

Connect this API to an AI agent Browse all specs

What you can do with Katana Manufacturing Orders & BOMs via MCP

Every endpoint below becomes a governed tool your AI agent (Claude, ChatGPT, or a customer-facing VX agent) can call — with scoped permissions, sandbox testing, and audit logs.

MethodPathOperationDescription
GET /manufacturing_orders listManufacturingOrders List manufacturing orders by status, order number or location
POST /manufacturing_orders createManufacturingOrder Create a manufacturing order to make a product variant
GET /manufacturing_orders/{id} getManufacturingOrder Get one manufacturing order with quantities, deadline and costs
PATCH /manufacturing_orders/{id} updateManufacturingOrder Update a manufacturing order (status, quantity, deadline, notes)
POST /manufacturing_order_make_to_order createMakeToOrderManufacturingOrder Create a make-to-order manufacturing order from a sales order row
GET /manufacturing_order_recipe_rows listManufacturingOrderIngredients List the ingredient rows of manufacturing orders
PATCH /manufacturing_order_recipe_rows/{id} updateManufacturingOrderIngredient Update an ingredient row (quantity, notes, batch)
GET /manufacturing_order_operation_rows listManufacturingOrderOperations List the operation steps of manufacturing orders
PATCH /manufacturing_order_operation_rows/{id} updateManufacturingOrderOperation Update an operation step (status, time, operator)
GET /manufacturing_order_productions listManufacturingOrderProductions List productions recorded against manufacturing orders
POST /manufacturing_order_productions createManufacturingOrderProduction Record a partial production (finished quantity) on a manufacturing order
GET /bom_rows listBomRows List bill-of-materials rows (ingredients per product variant)
GET /variants listVariants Find product and material variants by SKU or other filters
GET /locations listLocations List warehouses and factory locations

Authentication

katanaApiKey

Bearer token — sent as Authorization: Bearer <token>

Katana uses a live API key sent as Authorization: Bearer <key>.

How to get a credential

  1. Log in to Katana as an admin (API access needs the Professional plan or higher).
  2. Go to Settings > API.
  3. Select Add new API key and copy the key; it is shown once.

Permissions used

Katana API keys have no scopes: a key can read and write everything in the factory account.

Access Operations
Read listManufacturingOrders, getManufacturingOrder, listManufacturingOrderIngredients, listManufacturingOrderOperations, listManufacturingOrderProductions, listBomRows, listVariants, listLocations
Write createManufacturingOrder, updateManufacturingOrder, createMakeToOrderManufacturingOrder, updateManufacturingOrderIngredient, updateManufacturingOrderOperation, createManufacturingOrderProduction

Common errors

Code Meaning Fix
401 Missing, mistyped or deleted key Create a new key under Settings > API and update the credential.
403 Plan without API access Upgrade to a plan that includes the API.
422 / 400 Body failed validation (unknown variant_id or location_id, quantity above what is left) Look up ids with listVariants and listLocations, and read the order with getManufacturingOrder first.
429 More than 60 requests per 60 seconds Wait for the Retry-After seconds, then retry.

Store the key as a VX Agents credential (bearer token) so it is never pasted into chat.

Usage guide

Setup

Add your Katana API key as a bearer credential (Katana Settings > API > Add new API key; Professional plan or higher). If you make everything in one factory, pin its location_id (from listLocations with manufacturing_allowed=true) so new orders always land there.

Run a production day

  1. listManufacturingOrders with status (NOT_STARTED, BLOCKED, IN_PROGRESS, PARTIALLY_COMPLETED, DONE) and location_id to see the queue; getManufacturingOrder for one order's planned vs actual quantity and production_deadline_date.
  2. listManufacturingOrderIngredients with manufacturing_order_id; ingredient_availability shows which materials are missing (the usual reason an order is BLOCKED).
  3. listManufacturingOrderOperations with manufacturing_order_id lists the steps; updateManufacturingOrderOperation sets a step's status, total_actual_time or operators.
  4. When a batch is finished, createManufacturingOrderProduction with manufacturing_order_id and completed_quantity (is_final: true closes the order). Confirm the quantity with the user first: it moves stock.
  5. listManufacturingOrderProductions with manufacturing_order_ids shows what was already recorded.

Plan new work

  • listVariants with sku turns a SKU into a variant_id; listBomRows with product_variant_id shows its ingredients per unit.
  • createManufacturingOrder with variant_id, planned_quantity and location_id (optional production_deadline_date, additional_info).
  • createMakeToOrderManufacturingOrder with a sales_order_row_id builds an order linked to that sales line (create_subassemblies for nested products).
  • updateManufacturingOrder changes status, quantity, deadline or notes; updateManufacturingOrderIngredient changes one ingredient's quantity. Confirm every create or update with the user before calling it: they change stock plans and costs.

Good to know

  • Ids are integers. Dates are ISO 8601 UTC (2026-10-24T09:00:00.000Z); filter lists with created_at_min/updated_at_min.
  • Lists paginate with page (from 1) and limit (default 50, max 250).
  • Rate limit: 60 requests per 60 seconds; on 429 wait for Retry-After seconds.
  • Keys have no scopes, so a key can write everything: keep writes to what the user asked for.

Source: Katana API reference (https://developer.katanamrp.com/reference/getallmanufacturingorders), checked 2026-10-24.

How to use this spec

  1. Create a free VX Agents account (sandbox tools included).
  2. Open the marketplace and connect “Katana Manufacturing Orders & BOMs” to an agent.
  3. Expose it as an MCP server for Claude/ChatGPT, or chat with it directly.

Related APIs