Commerce

Add a product to a shopping cart on the public storefront, starting a new cart when no token is given. The product must be active and published on the storefront, a product with options requires a variant_id, and the request is refused when tracked stock would be exceeded. Nothing is charged and no stock is held — this only builds the cart; money moves at commerce.checkout. ALWAYS keep the cart_token it returns: it is how every later call finds this cart.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.add_to_cart \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_add_to_cart at https://app.chirply.io/api/mcp, same bearer token, same input.

Add or remove sellable product inventory and record the manual adjustment in the stock ledger. This can make an item available or sold out immediately on a live storefront. IMPORTANT SIDE EFFECT: it also switches stock tracking ON for that product permanently, even if it was selling with tracking off — so from then on the count is enforced, and a product whose inventory policy is 'deny' will REFUSE real customer orders as soon as the count reaches zero.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.adjust_inventory \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "delta": 1
  }'

Over MCP the same operation is the tool commerce_adjust_inventory at https://app.chirply.io/api/mcp, same bearer token, same input.

Apply a discount code to a storefront cart, or clear the one already on it. The code is checked against the store's active discounts on the server and rejected if it isn't valid, so this is also how you test whether a code works. The saving is recalculated into the cart's totals and will really be taken off the customer's charge at checkout. Nothing is charged here.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.apply_discount_code \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "cart_token": "example",
    "discount_code": "example"
  }'

Over MCP the same operation is the tool commerce_apply_discount_code at https://app.chirply.io/api/mcp, same bearer token, same input.

Make an already-connected, unused account domain the store's public address. This immediately changes public routing when the domain is active and replaces any prior custom address on this store; it does not modify registrar ownership.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.attach_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "store_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "domain_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_attach_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

Cancel a store or funnel order. An UNPAID order's pending Stripe payment is cancelled so it can never be charged, and the stock it held is released. A PAID order is marked cancelled and, when refund is true, everything not yet refunded is refunded on the seller's OWN Stripe account — REAL MONEY back to the buyer, irreversible; with refund false the money stays with the seller. restock puts units that were not already refunded back on tracked inventory. A subscription order must have its subscription cancelled first (commerce.cancel_subscription). Fires order_cancelled (and order_refunded when it refunds), starting matching automations and notifying webhook subscribers. Cancelling an already-cancelled order does nothing.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.cancel_order \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "refund": true
  }'

Over MCP the same operation is the tool commerce_cancel_order at https://app.chirply.io/api/mcp, same bearer token, same input.

Cancel a customer's recurring subscription on the seller's OWN Stripe account. This stops REAL future charges to a real customer's card: with at_period_end (the default) they keep what they paid for until the current billing period runs out and are never charged again; with at_period_end false the subscription ends IMMEDIATELY, any member access the purchase granted is revoked right away, and no refund of the current period is issued by this action. It does not delete the customer, the order history, or any member data.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.cancel_subscription \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "order_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_cancel_subscription at https://app.chirply.io/api/mcp, same bearer token, same input.

Place a REAL order for the contents of a storefront cart. This is the point of no return on the buyer's path: it re-prices every line, HOLDS the tracked stock so nobody else can buy it, creates a real pending order in the seller's books, creates or updates a CRM contact for the buyer from their email, and opens a live Stripe payment for the full total on the seller's OWN Stripe account (test mode only if the store is set to test). It returns that payment's client secret — the card is charged the moment that secret is confirmed, which for a shopper is them clicking Pay. Use only with a real buyer's real details and a total they have agreed to.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.checkout \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "cart_token": "example",
    "buyer_email": "ada@example.com"
  }'

Over MCP the same operation is the tool commerce_checkout at https://app.chirply.io/api/mcp, same bearer token, same input.

Connect a customer-owned hostname through the platform's Cloudflare for SaaS service and make it this store's public address. This changes public routing and may automatically create a CNAME in its connected Cloudflare account; it does not purchase a domain.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.connect_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "store_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "domain": "example"
  }'

Over MCP the same operation is the tool commerce_connect_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

Create a storefront collection. Products can be included immediately with product_ids, or assigned or changed later with commerce.set_collection_products, without changing or duplicating the products themselves.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.create_collection \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example",
    "slug": "example"
  }'

Over MCP the same operation is the tool commerce_create_collection at https://app.chirply.io/api/mcp, same bearer token, same input.

Create a discount code and put it LIVE immediately. Every code created here starts ACTIVE, applies to EVERY product in the store, and — unless you set usage_limit — can be redeemed an UNLIMITED number of times by anyone who learns the code. It comes straight off what real customers pay at storefront checkout, so a percentage value of 10000 basis points is a 100%-off code that gives the whole catalogue away for free. There is no draft state and no approval step after this call: use commerce.pause_discount to stop one.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.create_discount \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "example",
    "name": "Example",
    "discount_type": "percentage",
    "value_amount": 1
  }'

Over MCP the same operation is the tool commerce_create_discount at https://app.chirply.io/api/mcp, same bearer token, same input.

Create a reusable catalog product for storefronts and funnels. Active products become sellable immediately when the storefront is published.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.create_product \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example",
    "slug": "example",
    "price_amount": 1
  }'

Over MCP the same operation is the tool commerce_create_product at https://app.chirply.io/api/mcp, same bearer token, same input.

Create the account's storefront in draft. It remains private until Publish store is run. Regional settings default from the account's business profile country: a GB account's store starts in GBP with a GB checkout address, VAT-inclusive pricing and the UK rate presets loaded (an IE account: EUR, IE and the Irish presets); tax itself stays OFF until it is turned on. Any field given here overrides those defaults.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.create_store \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example",
    "slug": "example"
  }'

Over MCP the same operation is the tool commerce_create_store at https://app.chirply.io/api/mcp, same bearer token, same input.

Add a purchasable size, color or option combination to an existing product, with optional SKU, price override and independent inventory.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.create_variant \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "name": "Example"
  }'

Over MCP the same operation is the tool commerce_create_variant at https://app.chirply.io/api/mcp, same bearer token, same input.

Permanently delete a storefront collection and its product arrangement. Products themselves and completed orders are not deleted.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.delete_collection \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_delete_collection at https://app.chirply.io/api/mcp, same bearer token, same input.

Stop serving the native store from its custom hostname. The store remains available at its built-in platform address and the domain remains connected to the account for reuse; no registrar or DNS ownership is deleted.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.detach_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "store_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_detach_domain at https://app.chirply.io/api/mcp, same bearer token, same input.

Export storefront orders as a CSV file for an accountant, built from the figures persisted at checkout so it reconciles to the receipts buyers hold. level 'orders' gives one row per order: order and invoice number, invoice/paid date (in the store's timezone), buyer, currency, tax mode, net, tax and gross totals, discount, delivery, amount charged and refunds. level 'lines' gives one row per order line with the tax rate name, percentage and treatment (standard, zero-rated, exempt or not taxed) and the line's net, tax and gross — summing it by rate gives the tax-return figures. Returns the CSV text. Read-only; the export contains buyer names and emails.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.export_orders \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "level": "orders",
    "from": "example"
  }'

Over MCP the same operation is the tool commerce_export_orders at https://app.chirply.io/api/mcp, same bearer token, same input.

Mark a paid storefront order fulfilled and record optional carrier/tracking details. This is an outward operational claim that the seller has shipped or delivered the order.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.fulfill_order \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_fulfill_order at https://app.chirply.io/api/mcp, same bearer token, same input.

Fetch one shopping cart on the public storefront by its token: every line with its product, chosen variant, quantity, unit price and whether it is still in stock, plus the server-calculated subtotal, discount, shipping, tax and total in the smallest currency unit. Prices are recalculated live from the catalogue, so this is the authority on what checkout will actually charge. Reads only — it holds no stock and charges nothing. Returns nothing if the cart has expired or was already checked out.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.get_cart \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "cart_token": "example"
  }'

Over MCP the same operation is the tool commerce_get_cart at https://app.chirply.io/api/mcp, same bearer token, same input.

Fetch one storefront order with payment, customer, delivery and fulfillment fields, every line (product, SKU, variant, quantity, amounts, units refunded and restocked), the refunds recorded on it (amount, reason, who, when, Stripe refund id), whether and why it was cancelled, and the buyer's acceptance of the store's terms (when, which URL and version). Reads only.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.get_order \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_get_order at https://app.chirply.io/api/mcp, same bearer token, same input.

Fetch a storefront order using the order token from its confirmation link — the receipt page a buyer is sent to after checkout. Returns the order's number, payment status (whether Stripe has confirmed it yet), fulfilment status, buyer details, totals and every line item. Use this to poll whether a checkout you started has actually been paid. Reads only. Staff who have the order's internal id should use commerce.get_order instead.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.get_order_by_token \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "order_token": "example"
  }'

Over MCP the same operation is the tool commerce_get_order_by_token at https://app.chirply.io/api/mcp, same bearer token, same input.

Fetch one catalog product with pricing, inventory, fulfillment and storefront fields.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.get_product \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_get_product at https://app.chirply.io/api/mcp, same bearer token, same input.

Fetch this account's storefront branding, publishing status, payment routing and public address.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.get_store \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool commerce_get_store at https://app.chirply.io/api/mcp, same bearer token, same input.

Read the storefront's tax and VAT receipt settings: whether tax is on, whether prices are entered tax-inclusive or exclusive, the store's tax rates (id, name, percentage, and standard / zero-rated / exempt treatment) and default rate, the store timezone and default checkout country, the supplier details printed on receipts (legal and trading name, address, VAT number, company number, registered office), the invoice prefix and the number the next invoice will get, whether receipts are emailed, and the UK and Ireland rate presets available to add. Use the rate ids here for tax_rate_id on products and variants. Read-only; changes nothing.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.get_tax_settings \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool commerce_get_tax_settings at https://app.chirply.io/api/mcp, same bearer token, same input.

List persistent storefront carts, including identified buyers, discounts, totals and last activity, for abandoned-cart recovery and support.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.list_carts \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

Over MCP the same operation is the tool commerce_list_carts at https://app.chirply.io/api/mcp, same bearer token, same input.

List storefront collections used to merchandise related products into browsable groups.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.list_collections \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

Over MCP the same operation is the tool commerce_list_collections at https://app.chirply.io/api/mcp, same bearer token, same input.

List discount codes, eligibility, limits, active dates and redemption counts.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.list_discounts \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

Over MCP the same operation is the tool commerce_list_discounts at https://app.chirply.io/api/mcp, same bearer token, same input.

List storefront orders with customer, payment totals and fulfillment state. Funnel-only orders are excluded.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.list_orders \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

Over MCP the same operation is the tool commerce_list_orders at https://app.chirply.io/api/mcp, same bearer token, same input.

List products shared by storefronts and funnels, with price, visibility, SKU, product type and stock state.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.list_products \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

Over MCP the same operation is the tool commerce_list_products at https://app.chirply.io/api/mcp, same bearer token, same input.

List the recurring orders (subscriptions) sold through this account's storefront and funnels: buyer, amount, billing state (active, past_due after a failed renewal, canceled) and the Stripe subscription id on the seller's own Stripe account. Read-only.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.list_subscriptions \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 25,
    "offset": 0
  }'

Over MCP the same operation is the tool commerce_list_subscriptions at https://app.chirply.io/api/mcp, same bearer token, same input.

List the sizes, colors or other purchasable variants for one product, including option values, price overrides and stock.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.list_variants \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "product_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_list_variants at https://app.chirply.io/api/mcp, same bearer token, same input.

Pause or reactivate a discount code. Pausing prevents it from reducing any new customer checkout immediately.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.pause_discount \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_pause_discount at https://app.chirply.io/api/mcp, same bearer token, same input.

Show the exact payload an order event carries for one real order — order_paid, order_refunded or order_cancelled — as automations read it ({{order.…}} tokens) and as webhook subscribers receive it inside the signed envelope's `context`: order number, status, totals, the buyer's email and name, and every line with product, SKU, variant name and options, quantity, unit and line amounts and discount. Amounts are in the currency's smallest unit. Builds the payload only: nothing is sent, queued or changed.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.preview_order_event \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_preview_order_event at https://app.chirply.io/api/mcp, same bearer token, same input.

Publish the storefront to the open internet, or pause an already-public store. Publishing immediately exposes all active products and enables real checkout when payment mode is live.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.publish_store \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_publish_store at https://app.chirply.io/api/mcp, same bearer token, same input.

Refund all or part of a paid store or funnel order on the seller's OWN Stripe account (or their agency's Connect account, whichever took the payment). This MOVES REAL MONEY back to the buyer's card and out of the seller's Stripe balance, and cannot be undone. Choose an exact amount, or specific lines and quantities (their value is the default amount), or neither to refund everything still refundable. Refuses anything above what is left to refund on the order and on the Stripe charge. The refund is recorded on the order (amount, reason, note, who, when, Stripe refund id), the order becomes partially_refunded or refunded, refunded units can be put back on tracked stock, and the order_refunded event fires — starting matching automations and notifying webhook subscribers. Idempotent: repeating the same request (or the same idempotency_key) returns the first refund instead of refunding twice.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.refund_order \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_refund_order at https://app.chirply.io/api/mcp, same bearer token, same input.

Turn the store's required terms checkbox on or off. When required, checkout shows a box linking to the seller's terms that the buyer must tick before paying; the server refuses any checkout without it (storefront, custom domain and commerce.checkout alike), and each order records that the terms were accepted, when, and which URL and version. Changing the URL or wording starts a new version from now on; past orders keep the version their buyer accepted. Takes effect on the live storefront immediately.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.set_checkout_terms \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "required": true
  }'

Over MCP the same operation is the tool commerce_set_checkout_terms at https://app.chirply.io/api/mcp, same bearer token, same input.

Replace exactly which products are in a storefront collection, in display order (used for 'manual' sort). This is a FULL REPLACE: any product currently in the collection but left out of product_ids is removed from it — the product itself, its orders and its other collections are untouched. Pass an empty list to empty the collection.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.set_collection_products \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "collection_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "product_ids": [
      "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
    ]
  }'

Over MCP the same operation is the tool commerce_set_collection_products at https://app.chirply.io/api/mcp, same bearer token, same input.

Create or repair the store hostname's CNAME in its connected Cloudflare account and recheck SSL. This writes a real public DNS record but does not purchase a domain or charge 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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.setup_domain_dns \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "store_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_setup_domain_dns at https://app.chirply.io/api/mcp, same bearer token, same input.

Change how many units of one line are in a storefront cart, or remove that line entirely by setting the quantity to 0. Totals are recalculated on the server. The change is refused when tracked stock would be exceeded. Nothing is charged and no stock is held.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.update_cart_item \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "cart_token": "example",
    "line_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "quantity": 1
  }'

Over MCP the same operation is the tool commerce_update_cart_item at https://app.chirply.io/api/mcp, same bearer token, same input.

Update a catalog product. This edits an item that may be ON SALE RIGHT NOW on a published storefront: a new price_amount, sale price/window or tax rate changes what real customers are charged from the moment it saves, and storefront_status can put the product on sale or pull it off in public immediately. Price changes affect future purchases only; completed order snapshots are never rewritten. A cart filled at an old price is re-priced at checkout and the shopper is shown the change.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.update_product \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_update_product at https://app.chirply.io/api/mcp, same bearer token, same input.

Update customer-facing storefront branding, merchandising copy, support details, payment routing, and the tax / VAT receipt / regional settings (the same fields commerce.update_tax_settings takes). Omitted fields are unchanged. Several fields move real money and are the reason this needs approval: changing stripe_account_id redirects where every future sale is PAID INTO; setting payment_mode to 'test' makes a live public storefront stop collecting real money entirely while still appearing to take orders; and the tax fields change what real customers are charged (tax added on top of tax-exclusive prices) and what their receipts say, from the next page load. Past orders are never re-taxed.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.update_store \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_update_store at https://app.chirply.io/api/mcp, same bearer token, same input.

Save the storefront's tax and VAT receipt settings — tax on/off, tax-inclusive or exclusive prices, the rate list and default rate, supplier details printed on receipts, invoice prefix and next number, receipt emails, store timezone and default checkout country. Omitted fields are unchanged. This changes what REAL customers are charged from the next page load (tax-exclusive prices get tax added at checkout) and what every new receipt says; paid orders keep the tax they were charged and their receipts never change. Presets are labelled starting points — which rate applies to which product is the seller's decision.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.update_tax_settings \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "tax_enabled": true,
    "prices_include_tax": true
  }'

Over MCP the same operation is the tool commerce_update_tax_settings at https://app.chirply.io/api/mcp, same bearer token, same input.

Update one purchasable option (a ticket tier, a size) of a product: its name, SKU, own price, tax rate, or a scheduled sale price with start and end times. This edits an item that may be ON SALE RIGHT NOW: a new price, sale or tax rate is what real customers are charged on the storefront from the moment it saves. Past orders are never changed. Omitted fields are unchanged.

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

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.update_variant \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_update_variant at https://app.chirply.io/api/mcp, same bearer token, same input.

Recheck the store domain's Cloudflare hostname and SSL status, then save the latest verification state. This does not change DNS or spend money.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/commerce.verify_domain \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "store_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool commerce_verify_domain at https://app.chirply.io/api/mcp, same bearer token, same input.