20 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.
Confirm stock changes
inventory.apply_batchwriteconfirm
Atomically receive, remove, return, count or transfer stock for this account. Updates Commerce availability immediately and appends permanent movement history. Retry the same request UUID after a timeout. Counts reject changed stock; removals protect checkout holds; purchase-order receipts enforce remaining quantities. Returns restock only and never refund money.
Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.
Parameters
Field
Type
Required
Description
request_id
string (uuid)
required
Unique UUID per batch; reuse the same UUID and contents after a timeout to prevent duplicate stock changes.
Over MCP the same operation is the tool inventory_apply_batch at https://app.chirply.io/api/mcp, same bearer token, same input.
Check stock batch
inventory.batch_statusread
Check whether an inventory request was committed, waiting for an in-flight database transaction with the same request UUID. Reads only; use this after a network error before editing a failed batch.
Over MCP the same operation is the tool inventory_batch_status at https://app.chirply.io/api/mcp, same bearer token, same input.
Choose catalog product
inventory.catalog_productsread
Search physical Commerce products to link existing stock into Inventory without creating a second product. Reads only; choose an exact variant when has_variants is true.
Over MCP the same operation is the tool inventory_catalog_variants at https://app.chirply.io/api/mcp, same bearer token, same input.
Export inventory CSV
inventory.export_itemsreadadmin only
Export a page of inventory as formula-safe CSV, with a next offset for larger catalogs. Includes IDs, shared product fields, primary barcode and current quantities; quantities are read-only during import. Reads only.
Over MCP the same operation is the tool inventory_get_item at https://app.chirply.io/api/mcp, same bearer token, same input.
Import inventory items
inventory.import_itemswriteconfirmadmin only
Import up to 500 inventory metadata rows atomically. Explicit item IDs edit existing records; blank IDs create new draft Commerce products. Names, prices and stock tracking are shared with Commerce. Quantities are changed separately through receiving or counts. No messages or payments.
Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.
Parameters
Field
Type
Required
Description
rows
object[]
required
Validated inventory item rows. Whole import succeeds or none of its changes persist.
rows[].id
string (uuid)
optional
Existing inventory item ID to edit; omit to add an item.
rows[].product_id
string (uuid)
optional
Existing physical Commerce product to track; omit to create a draft product.
rows[].variant_id
string (uuid)
optional
Exact variant of the selected product, required when the product has variants.
rows[].name
string
required
Product name, or variant name when editing a variant. Shared with Commerce.
rows[].sku
string
optional
Stock keeping code. Blank by default. Default: ""
rows[].currency
string
optional
Lowercase ISO currency for a new product; existing product currency is preserved. Default: "usd"
rows[].price_amount
integer
required
Selling price in minor currency units, e.g. 1299 for USD 12.99. Shared with Commerce.
rows[].cost_amount
integer
optional
Reference unit cost in the product currency's minor units. Used for estimated stock value; not an accounting valuation. Default: 0
rows[].unit
string
optional
Unit label; quantities are whole units. Default each. Default: "each"
rows[].supplier_id
string (uuid) (or null)
optional
Preferred supplier; omit to preserve an existing assignment.
rows[].reorder_point
integer
optional
Flag low stock when available quantity reaches this level. Default 5. Default: 5
rows[].target_quantity
integer
optional
Suggested replenishment target. Default 20; open purchase order quantities are deducted from suggestions. Default: 20
rows[].is_active
boolean
optional
Active status; omit to preserve an existing item's status.
rows[].barcodes
object[]
optional
Barcode aliases and pack quantities. Empty array clears all; omission preserves existing codes or imports an existing variant barcode.
rows[].barcodes[].code
string
required
Barcode text, preserving leading zeros. Printable ASCII supported by Code 128 labels.
rows[].barcodes[].pack_quantity
integer
optional
Units added per scan. A case barcode may represent 12 units; default 1. Default: 1
Over MCP the same operation is the tool inventory_import_items at https://app.chirply.io/api/mcp, same bearer token, same input.
Prepare barcode labels
inventory.label_dataread
Return item names, prices and exact barcode values with pack quantities for printable labels. This prepares data only; it does not start a printer or change stock.
Over MCP the same operation is the tool inventory_label_data at https://app.chirply.io/api/mcp, same bearer token, same input.
Find stock
inventory.list_itemsread
Search and page the account's inventory with variant details, barcode aliases, location balances, checkout reservations and reference costs. Reads only.
Parameters
Field
Type
Required
Description
limit
integer
optional
Max rows to return (1–100). Default: 25
offset
integer
optional
Rows to skip. Default: 0
search
string
optional
Search product/variant name or SKU.
active
boolean
optional
Filter active or archived inventory items; omit for both.
low_stock
boolean
optional
Return items at or below the reorder point after checkout holds.
Over MCP the same operation is the tool inventory_list_locations at https://app.chirply.io/api/mcp, same bearer token, same input.
View stock movements
inventory.list_movementsread
Page the account's permanent stock history, including opening quantities, barcode batches and changes from the shared Commerce catalog. Returns actor IDs, timestamps, locations, changes and resulting quantities. Reads only.
Over MCP the same operation is the tool inventory_list_movements at https://app.chirply.io/api/mcp, same bearer token, same input.
View purchase orders
inventory.list_purchase_ordersread
List draft, ordered, partially received, received and cancelled purchase orders with their lines, quantities, delivery location and version. Reads only.
Over MCP the same operation is the tool inventory_list_suppliers at https://app.chirply.io/api/mcp, same bearer token, same input.
Scan barcode
inventory.lookup_barcoderead
Resolve a barcode exactly within this account, preserving leading zeros and returning its pack quantity. An unknown code returns item null and never creates or changes stock.
Parameters
Field
Type
Required
Description
code
string
required
Exact text emitted by a USB scanner, without its Enter/Tab terminator.
Over MCP the same operation is the tool inventory_lookup_barcode at https://app.chirply.io/api/mcp, same bearer token, same input.
View reorder list
inventory.reorderread
Find active items at or below their available-stock reorder point. Suggested quantities target the configured level after subtracting all outstanding ordered units. No orders are placed and no suppliers are contacted.
Over MCP the same operation is the tool inventory_reorder at https://app.chirply.io/api/mcp, same bearer token, same input.
Save inventory item
inventory.save_itemwriteconfirmadmin only
Create or edit an inventory item linked to the shared Commerce catalog. New products start as drafts. Names, SKUs and selling prices also change in Commerce; stock tracking becomes enabled and sold-out policies apply immediately. Barcode aliases are unique within the account. No payments or messages.
Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.
Parameters
Field
Type
Required
Description
id
string (uuid)
optional
Existing inventory item ID to edit; omit to add an item.
product_id
string (uuid)
optional
Existing physical Commerce product to track; omit to create a draft product.
variant_id
string (uuid)
optional
Exact variant of the selected product, required when the product has variants.
name
string
required
Product name, or variant name when editing a variant. Shared with Commerce.
sku
string
optional
Stock keeping code. Blank by default. Default: ""
currency
string
optional
Lowercase ISO currency for a new product; existing product currency is preserved. Default: "usd"
price_amount
integer
required
Selling price in minor currency units, e.g. 1299 for USD 12.99. Shared with Commerce.
cost_amount
integer
optional
Reference unit cost in the product currency's minor units. Used for estimated stock value; not an accounting valuation. Default: 0
unit
string
optional
Unit label; quantities are whole units. Default each. Default: "each"
supplier_id
string (uuid) (or null)
optional
Preferred supplier in this account; null clears it. Default: null
reorder_point
integer
optional
Flag low stock when available quantity reaches this level. Default 5. Default: 5
target_quantity
integer
optional
Suggested replenishment target. Default 20; open purchase order quantities are deducted from suggestions. Default: 20
is_active
boolean
optional
Whether staff can select this inventory item for new operations. Archiving here preserves Commerce listing visibility. Default: true
barcodes
object[]
optional
Barcode aliases and pack quantities. Empty array clears all; omission preserves existing codes or imports an existing variant barcode.
barcodes[].code
string
required
Barcode text, preserving leading zeros. Printable ASCII supported by Code 128 labels.
barcodes[].pack_quantity
integer
optional
Units added per scan. A case barcode may represent 12 units; default 1. Default: 1
Over MCP the same operation is the tool inventory_save_item at https://app.chirply.io/api/mcp, same bearer token, same input.
Save stock location
inventory.save_locationwriteconfirmadmin only
Create or rename a stock location, or deactivate an empty location with no open purchase orders. The default Commerce location remains active. No messages or payments.
Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.
Parameters
Field
Type
Required
Description
id
string (uuid)
optional
Existing location ID; omit to create.
name
string
required
Location name, such as Main store or Stockroom.
is_active
boolean
optional
Whether staff can use this location. Locations holding stock or open purchase orders cannot be deactivated. Default: true
Over MCP the same operation is the tool inventory_save_location at https://app.chirply.io/api/mcp, same bearer token, same input.
Save purchase order
inventory.save_purchase_orderwriteconfirmadmin only
Save a draft purchase order, mark it ordered for later receiving, or cancel its unreceived remainder. Ordered lines cannot be edited; partial receipts remain in history. This records purchasing intent only: it does not contact the supplier, buy goods or move money.
Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.
Parameters
Field
Type
Required
Description
id
string (uuid)
optional
Draft purchase order to edit, or open order to cancel; omit to create.
version
integer
optional
Current purchase order version, required when editing or cancelling.
supplier_id
string (uuid)
required
Active supplier in this account.
location_id
string (uuid)
required
Active delivery location.
currency
string
optional
Order currency; must match all included items. Default: "usd"
expected_on
string (date) | ""
optional
Expected delivery date YYYY-MM-DD, or blank. Default: ""
notes
string
optional
Purchase order notes. No messages are sent. Default: ""
status
"draft" | "ordered" | "cancelled"
optional
Draft can be edited; ordered freezes lines for receiving; cancelled closes remaining quantities. No purchase or payment is placed with the supplier. Default: "draft"
Over MCP the same operation is the tool inventory_save_purchase_order at https://app.chirply.io/api/mcp, same bearer token, same input.
Save inventory supplier
inventory.save_supplierwriteconfirmadmin only
Create or update a supplier's name, contact information, address and internal notes in this account. No email, SMS, purchase or payment is sent.
Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.
Parameters
Field
Type
Required
Description
id
string (uuid)
optional
Existing supplier ID; omit to create.
name
string
required
Supplier business name.
email
string (email) | ""
optional
Supplier email for your records. Saving never sends an email. Default: ""
phone
string
optional
Supplier phone for your records. Default: ""
address
string
optional
Supplier postal address. Default: ""
notes
string
optional
Ordering instructions or internal notes. Default: ""
is_active
boolean
optional
Active suppliers can be chosen on new purchase orders. Default: true
Over MCP the same operation is the tool inventory_save_supplier at https://app.chirply.io/api/mcp, same bearer token, same input.
View inventory overview
inventory.summaryread
Read current item, unit, low-stock and open purchase-order totals for this account, with estimated stock value separated by currency. Reads only; no messages or charges.