Commerce

Storefront catalog, products, variants, inventory, and Amazon product resolution.

181 verbs in this family.

activateProductSet writeconsent Activate a named product set (menu): ONE action that publishes exactly its members to the storefront.
addOrderProperty write Add a column to a shop's orders: "Receipt number", "Cake finish", "Table".
addProductsToSet write Add products to a named product set (menu), by set id or slug.
addShopNotificationRecipient write Add an email address to ONE shop's order-notification recipients, optionally subscribed to specific event types (order.paid, refund.issued, payment.failed, payment.disputed, omit eventTypes for all).
applyPackageUpdate write Take the newer version of an Exchange listing onto the member's own copy of it: same app, same slug, same links, new contents.
archiveOrderDocumentTemplate write Archive a document template so it no longer appears for new documents.
archiveProduct writeconsent Archive ONE catalog product: the SAFE way to retire an item.
archiveRoom write Retire a room: it leaves the room picker and the calendar's Room filter, and no new entry can pick it.
attachModifierGroup writeconsent Attach a modifier group to a product, or narrow it to ONE variant (e.g.
attachPaymentLinkToEntry write Attach an existing payment link to one shop entry so the entry can show deposit, paid, and balance state.
authorModifierGroup write Author a reusable modifier GROUP and its full choice set in one call: the structured model behind "pick one color", "choose accessories", and "add gift wrap".
authorProductOptions write Author a product's FULL option matrix in one call: its option GROUPS (e.g.
backfillConnectedAccountPayments writeexternal Find the payments a Space took on its bound Stripe account in the last 90 days WITHOUT a Cloud checkout (a Stripe payment link, a charge made in the Stripe dashboard) and book the ones the payments…
bindSpacePaymentAccount writeconsent Bind a personal Stripe Connect account to a Space so Offers charge through it (e.g.
bindStorefrontOwner writeconsent Scope a Studio app's storefront to ONE brand (Space) so it serves only that brand's products: the fix for a multi-brand account whose storefront shows every brand at once.
browseExchange read Browse The Exchange, the public catalog of apps, pages, skills, workflows, projects and Spaces, the same way a person browses the storefront.
buyListing writeconsent Price a paid Exchange listing (packageId) or a paid App Library app (appId) for the member and hand back the checkout link they open to pay.
cancelApprovedOrder writedestructive Call off an order the user approved.
cancelRecurringPaymentLink writeconsent Stop a repeating invoice so no further ones are raised.
checkShopSender write Re-check whether a shop's sending domain has verified (SPF/DKIM) and explain what it is waiting on.
clearTaxRate write Remove a tax answer so it reads as UNSET again.
commerceConfirmCart read Render the inline Amazon order-confirmation card for one product the user chose.
commerceFindItem read Find Amazon products for an 'order this' / 'add this to cart' intent.
createAddOn write Attach ONE add-on (modifier) to a product: e.g.
createCoupon write Mint ONE discount code for a shop.
createInvoice writeexternal Create and finalize one shop invoice from a reviewed preview.
createLocation write Create a shop's fulfillment location: the pickup/fulfillment anchor an order joins to.
createOffer write Create a Space Offer as a PRIVATE draft (never auto-publishes).
createPaymentLink write Create one Cloud-hosted payment link with library products, manual lines, configured products, an optional deposit, and an email, phone, or saved client.
createProductSet write Create a NAMED product set (a menu) in a Studio app's catalog: a stable, ordered list of products a merchant can activate as a unit.
createRecurringPaymentLink writeconsentexternal Put a payment request on a repeat: the same lines, client and terms billed every N days, weeks, months or years until cancelled, or for a set number of invoices, or up to an end date.
createRoom write Add a bookable room to a shop Space.
createVariant write Add ONE variation to a product: e.g.
createVenue write File a delivery venue in a shop's venue book, so an order can pick it instead of retyping the address.
deactivateCoupon write Stop a coupon being redeemed.
deactivateProductSet writeconsent Deactivate a named product set (menu): sends exactly its members back to draft, pulling that menu off the storefront while every product row, price, and history survives.
deleteAddOn writedestructive Remove ONE add-on (modifier) from a product.
deletePaymentLink writedestructiveconsent Soft-delete a payment link so it stops accepting payment while its payment history remains.
deleteProduct writedestructiveconsent Request PERMANENT deletion of ONE catalog product and its variants/add-ons.
deleteVariant writedestructive Remove ONE variation from a product.
detachModifierGroup write Detach one modifier-group attachment from a product or variant without deleting the reusable group.
discoverForMe read Given what the member is working on right now, return Exchange listings across every kind that would help, each with the REASON it was suggested.
draftCloudNumberRegistration write Fill in the Cloud Numbers 10DLC carrier registration on the owner's behalf and save it as a draft, so nobody types a twenty field form.
enableSpacePortal writeconsent Turn a Space's member portal on or off, and choose which sections it exposes.
generateOrderDocument write Generate a document from a template and a live order: fills every merge field from the order, its entry and its ledger, stores a frozen copy on the order as a draft, and notes it on the order's…
getCartSettings read Read how a shop's checkout works: what it collects, which payment methods it accepts, whether buyers pay on the shop's own page or on the hosted payment page, its sales-tax rate, and whether it asks…
getGoLiveReadiness read Answer "what still stands between this shop and taking real money from real customers" in one call.
getInvoiceEmailSettings read Read a shop's CUSTOMER invoice email settings: whether the branded lifecycle emails are on, which kinds send (invoice.sent, invoice.reminder, invoice.payment_received, invoice.paid), the reminder…
getOffer read Get one Offer by id: pricing, publish state, Stripe sync ids, whether the Space payment account is ready, and the public checkout link.
getProductConfiguration read Read a product's EFFECTIVE configuration: every modifier group that applies (with any variant narrowing), its owner-authored title, choices after exclusions and overrides, defaults, exclusivity,…
getProductRelations read Read ONE product's full structure: its variations (each with an absolute price) and its add-ons / modifier lists (each with a signed price delta, owner-authored group name, and single/multiple…
getShopFollowUp read Read ONE shop's customer follow-up email: whether it is on, how many hours after pickup or delivery it waits (1 to 168, default 24), the subject and body (placeholders {{firstName}}, {{shopName}},…
getShopLoop read Read ONE shop loop by id or seed key.
getShopNotificationSettings read Read ONE shop's order-notification settings: whether money-event emails are on, the additional recipients and which event types each hears (order.paid, refund.issued, payment.failed,…
getShopRailsReadiness read Answer "can this shop sell a gift card and bill an invoice yet, and if not what is the next thing to do about it" in one call.
getShopRewards read Read a shop's rewards program: whether points are on, points per dollar, the redemption step (points for how much credit), the tier names and thresholds, the punch card size and its reward, the…
getShopRules read Read a shop's house rules: zero-inventory behavior, fallback lead time, ordered category or name-pattern lead-time rules, the paid rush window and which products sell it, low-stock floor,…
getStorefrontState read Diagnose a Studio app's storefront: the owner the product embed resolves to, the catalog's product count broken down by publish state (draft / active / archived / storefront-published), and a…
getTaxSettings read Read what a shop charges in sales tax: the online shop's own rate, and every pickup location's rate with where that answer comes from.
importProductsFromTable write Promote a Cloud Table into real commerce products for a Studio app in one step: the connector-independent path to a live catalog.
installPackage write Deliver an Exchange listing the member is entitled to: an app is cloned into their Studio as their own copy, a page pack lands in one Space, a skill is equipped in one Space and no other, and a verb…
issueGiftCard write Issue ONE gift card directly, with no order behind it: the counter sale.
launchAdSet writeconsentexternal Run an ad set the user already approved.
launchApp writeexternal Run an app from ONE SENTENCE to a reviewed Exchange listing, filing every step on one Task row and stopping at the consent gates.
linkHomeSystem writeconsent Link a solar or battery site your Space installed to one of your portal members, so they see its production, use, net and battery charge in your portal and in their Home.
listCloudNumberPromotionCodes readexternal List the Cloud Number promotion codes on the platform Stripe account, each with whether it is active, how many times it has been redeemed and its redemption limit.
listCoupons read List a shop's discount codes and what each one is worth: code, flat or percent value, any minimum cart (including one that only bites from a customer's second redemption onward), window, redemption…
listGiftCards read List the gift cards a shop has issued and its exact redeemable liability per currency, which is what is left on its ACTIVE cards.
listInvoices read List a shop's invoices with customer, total, due date, payment link, and truthful payment state.
listLocations read List a shop's fulfillment locations: every location under the app's owner with its full stored shape: name, address, timezone, weekly availability (pickup slots in minutes-from-midnight local time),…
listModifierGroups read List the reusable modifier-group library for a Studio app, including every choice, stable ID, price delta, availability, default, and exclusivity rule.
listMyEntitlements read What the member can access: every Exchange listing they hold, plus the paid or owner-granted placed pages, profiles and files they have been let into.
listOffers read List Offers owned by a Space (including private drafts).
listOptionRules read List the option rules ("when A is selected, B is unavailable") a shop holds, each with its rule id and sentence ("Vegan hides Cream cheese frosting.").
listOrderDocumentMergeFields read List every merge field a document template may use, such as {{client.name}}, {{event.startTime}}, {{venue.address}} or {{ledger.balanceDue}}, with what each reads from the order.
listOrderDocuments read List the documents generated for one order, newest first, with title, status (draft, sent, signed, void) and when each was rendered.
listOrderDocumentTemplates read List a shop's document templates (proposals, agreements, work orders, internal sheets, invoices, price cards, or any the shop composed) with their sections and version.
listOrderProperties read Read the columns a shop has added to its own orders: their ids, their names, their stable keys and their types.
listPaymentLinks read List a shop's payment links with customer, payment status, amount paid, balance, and Cloud URL.
listPayments read Answer "did I get paid?" from The Cloud's settled-charge ledger: every payment that actually settled to the caller or a Space they manage: offer/membership subscription cycles,…
listPortalMembers read List the members of a brand's member portal: the people who signed in or created an account on the brand's own site, with how many orders they have placed with that brand, what they have spent, and…
listProducts read List the products a Studio app's STOREFRONT SERVES, with each item's publish state (draft / active / archived / published / hidden), effective storefront price, currency, and SHIPS (whether each…
listProductSets read List a Studio app's named product sets (menus) with each set's slug, member count, always-on pin, and status.
listRecurringPaymentLinks read List a shop's repeating invoices with their cadence, when the next one goes out, how many have been sent, and how the run ends.
listRooms read Read a shop's rooms: the bookable spaces an entry can hold for its event window (tasting room, event hall, patio), A to Z, archived ones left out.
listShopLoops read List ONE shop's customer loops: each is a per-order or per-entry send, never a broadcast.
listSpacePaymentAccounts read List the caller's personal Stripe Connect accounts AND, when a Space is given, the accounts that Space actually charges through: the picker for "use Teka Stripe on ENOK" and the answer to "what does…
listSpaceSubscribers read Who is subscribed to a Space, what they pay, when they are charged next, and how each of them actually gets in.
listTemplatePackage writeconsent Put an APPROVED listing of the member's on sale in The Exchange, which makes it publicly buyable.
listVenues read Read a shop's venue book: the delivery addresses it has saved (wedding venues, planners' offices, hotels), A to Z.
mintCloudNumberPromotionCode writeexternal Mint a Cloud Number promotion code on the platform Stripe account: a 100 percent, forever coupon restricted to the Cloud Number plans, capped at a number of redemptions, with a customer-facing code…
moveProductsToSpace writeconsent File one or more catalog products under a brand (Space) so a Space-bound storefront serves only that brand and publish-all scoped to it never sweeps a sibling: the fix for a multi-brand account…
moveShopToSpace writeconsent Move a LEGACY shop onto the Space it lives in, so its rows are filed under that Space instead of a person: the self-serve repair for a shop that is filed under its owner while living in a Space.
placeApprovedOrder writedestructiveexternal Place an order the user has ALREADY approved, by driving their own machine through the merchant's checkout in a session opened for this order alone.
placeConfiguredOrder writeconsent Place a real order for a CONFIGURED product on a Cloud shop: a builder cake, a made-to-spec item: by handing over the configuration itself: which product, which variant, which option choices, any…
previewInvoice read Preview the exact customer, lines, currency, total, due date, and memo for a shop invoice.
previewOrderDocument read Render a template, or unsaved sections, without storing anything: against a real order when orderId is given, otherwise against a sample order.
previewShopLoop read Render ONE shop loop's subject, body, link and button against a real order or sample names.
proposeAdBudget write Propose how much each ad in an ad set may spend, and put that table on the user's approval card.
provisionPortalMember writeconsent Admit someone to an app's member portal by email, and state what they hold.
publishAllProducts writeconsent Publish EVERY draft product in a Studio app's catalog to the storefront in one call: the "go live" verb for a freshly migrated catalog where every item landed as draft.
publishProduct writeconsent Publish ONE catalog product to a Studio app's storefront: flips it from draft (or archived) to active so the product embed serves it.
publishProducts writeconsent Publish MANY catalog products to a Studio app's storefront in ONE call: pass the list of product IDs to take live together.
readCloudNumberRegistration read Read Cloud Numbers 10DLC registration status only.
readListing read Open ONE Exchange listing: its description, its version and changelog, the submission gates a reviewer passed it on, how many people installed it, and whether the member already owns a copy (and…
readMembershipGate read Does the member hold a live membership of a Space, and why.
readOrder read Read one shop order in full, by order id or order number: order number, customer name, email and phone, the additional contact beside the customer (most often a wedding planner: role, name, phone…
readOrderDocument read Read one generated document: its frozen markdown exactly as rendered, status and template version.
readOrderDocumentTemplate read Read one document template with every section in print order.
readOrderExecution read Say where one order stands, in one word.
readPurchaseApproval read Read what the user did about an order you asked them to approve.
readPurchaseReceipts read Read settled wallet purchase receipts from the append-only ledger.
readSpendPolicy read Read the spending limits the user has put on their wallet for agents: whether agent spending is on at all, which currency the limits bound, the most you may spend on one order, the most across a…
readTipsReport read Read a shop's tips for a period: the total, who earned what (by the person who fulfilled or delivered each order), totals by day, Monday-start week and month, and each tipped order with date, order…
recoverPayment writedestructiveconsentexternal Recover a payment that failed or never started on ONE form response, order or entry.
refundPayment writedestructiveconsentexternal Refund ONE settled payment (a `paymentId` from listPayments) back to the payer's card: in full, or a partial `amountMinor`.
removeOrderProperty writedestructive Remove a column from a shop's orders.
removeProductsFromSet write Remove products from a named product set (menu), by set id or slug.
removeShopNotificationRecipient write Remove an email address from ONE shop's order-notification recipients.
removeShopSender writedestructiveconsent Stop a shop sending from its own domain: removes the sending address, releases the domain from the Cloud mail account, and puts receipts, form auto-replies, and form notifications back on the Cloud…
renameOrderProperty write Rename a shop's order column, or restate its choices.
reorderOrderProperties write Put a shop's order columns in the order they should read, top to bottom, on every order document.
requestPurchaseApproval write Show the user one exact order and ask them to approve it.
researchPurchase read Research one purchase brief from need to quote.
revokeMembership writedestructiveconsentexternal End a member's membership AND stop their billing, from now.
revokePortalMember writedestructive Revoke one person's access to a brand's member portal.
searchCloudNumbers readexternal Search live carrier availability for a Cloud Number by area code, city and state, state, or ZIP, returning eight numbers a page that can be bought right now, ranked by how easy each is to say…
seedOrderDocumentTemplates write Add the platform's generic starting templates (Proposal, Agreement, Work order, Internal sheet, Invoice, Price card) to a shop that does not have them yet.
sendInvoice writedestructiveconsentexternal Stage or send one invoice email.
sendPaymentLink writedestructiveconsentexternal Send a payment link by email or text.
setCartSettings write Change how a shop's checkout works: update phone and notes collection, choose accepted payment methods, choose the checkout page, set the shop's sales-tax rate, and switch the checkout tip row on or…
setEntryRequirements write Choose which fields a new Interactions entry must carry, separately for entries staff type in (handEntered) and entries a customer submits through a form (customerSubmitted).
setIncludedItemsPolicy write Set the "first N included, then X each" pricing policy on a modifier group.
setInventory write Set the on-hand inventory count on a product (turns inventory tracking on) or on one variant.
setInvoiceEmailSettings write Change a shop's CUSTOMER invoice emails, the branded lifecycle mail a buyer receives.
setNoTax write Record that a shop or one of its pickup locations charges NO sales tax.
setOfferVisibility writeconsent Set an Offer public (listed + buyable) or private (hidden).
setOptionExclusions write Exclude specific option CHOICES from ONE product, or restore them: without editing the shared modifier group every other product reads.
setOptionRule write State a rule BETWEEN two option choices: when `whenChoiceId` is selected, `hidesChoiceId` is unavailable (e.g.
setOrderAdditionalContact write Set or clear the additional contact on one shop order: a second person beside the customer, most often the wedding planner.
setOrderChipColors write Change one order Status or Stage color for a shop.
setOrderDocumentTemplate write Create a document template, or replace an existing one's title, audience and sections (pass templateId).
setOrderFulfilledBy write Say who fulfilled or delivered one or more orders, the person each order's tip goes to.
setOrderPropertyValue write Answer one of a shop's own order columns on ONE order: write "R-4417" into its Receipt number.
setOrderStageLabels write Rename a shop's order fulfillment stages, and choose the color new, unopened orders are flagged in.
setProductOptionPrices writeconsent Replace a SERVICE product's whole option price table: what the provider charges per unit of each option a customer can place (e.g.
setProductSetAlwaysOn write Pin (or unpin) a product set always-on.
setProductsShipping write Answer the SHIPS question for MANY catalog products in ONE call: pass the product IDs and ships:true or ships:false.
setShopFollowUp write Write ONE shop's customer follow-up email: turn it on or off, set the delay in hours after pickup or delivery, write the subject and body, paste an https Google review link, and name the button.
setShopLoop write Create or update ONE shop loop by id.
setShopLoopEnabled write Turn ONE shop loop on or off by id.
setShopNotifications write Turn ONE shop's order-notification emails on or off and/or set the per-hour cap.
setShopRewards write Change a shop's rewards program: points on or off, points per dollar, the redemption step, tier names and thresholds, punch card on or off, card size and reward, the spend ladder steps, and the…
setShopRules write Set a shop's house rules.
setShopSender write Register the address a shop sends receipts, form auto-replies, and form notifications from, and get back the SPF/DKIM DNS records to publish for its domain.
setSpendPolicy writeconsent Ask to change the spending limits on the user's wallet.
setTaxRate write Set the sales-tax rate a shop charges, either for the ONLINE SHOP (omit `location`) or for ONE pickup location (name it in `location`, which overrides the shop for orders fulfilled there).
setupGiftCardRail write Set a shop up to sell gift cards, in one call: find or create its gift card product, then say which amounts it sells and whether a buyer may name their own.
startCloudNumberCheckout writeconsentexternal Open a Stripe Checkout link to buy one Cloud Number on a plan, monthly or annual.
stopMembershipRenewal writeconsentexternal Stop a member's recurring charge WITHOUT ending their access: the verb for a member who has paid another way, by check or transfer, and must not be billed again while keeping everything they have.
submitCloudNumberRegistration writedestructiveconsentexternal Submit the saved Cloud Numbers 10DLC registration to the carrier.
submitTemplatePackage write Submit one of the member's OWN Studio apps to The Exchange as a listing, which freezes a snapshot of it and sends that snapshot to review.
suggestAmazonProducts read Suggest Amazon products in chat as affiliate-tagged shopping cards so the user can buy and commission flows to Teka on the resulting cart.
suggestCloudNumbers readexternal Suggest Cloud Numbers a person would actually want: the same eight-a-page list searchCloudNumbers returns, ranked by how easy each one is to say and write down (repeated digits, round hundreds,…
syncCheckoutBranding writeexternal Re-run the hosted checkout branding sync for a shop.
tagProductImages write Say which of a product's pictures belongs to which of its options, so the tile, the product page, the cart row and the receipt all show the picture for the flavor (or size, or color) the shopper…
unpublishAllExcept writeconsent Keep ONLY the named products live and send every other live product back to draft: the inverse of publishAllProducts, and the verb behind "deactivate everything that is not on the forever menu, but…
unpublishProduct writeconsent Unpublish ONE catalog product from a Studio app's storefront: flips it from active back to draft, pulling it off the storefront while keeping the product row intact.
unpublishProducts writeconsent Unpublish MANY catalog products from a Studio app's storefront in ONE call: pass the list of product IDs to pull off the storefront together.
updateAddOn write Edit ONE add-on (modifier) in place: name, price delta, required flag, availability, order, or its group (modifierListName / selectionType).
updateCoupon write Change what an existing coupon is worth or who may redeem it: value, minimum cart, the bigger minimum that applies from a customer's second redemption onward (minSubtotalAfterFirstMinor), window,…
updateLocation write Edit ONE fulfillment location in place: rename it, set pickup hours (weekly availability: per-weekday slots in minutes-from-midnight LOCAL time, e.g.
updateOffer write Update an Offer's name, description, pricing, or where guests land after paying (successReturnUrl: an https page on the owner's own site; null clears it back to the shop default, then the Cloud's…
updatePortalMemberEntitlements writeconsent Replace what one existing portal member can reach.
updateProduct write Edit ONE catalog product in place: name, description, TYPE (physical, digital or service, where a service says how it is booked), base price (in minor units, e.g.
updateRecurringPaymentLink write Change a repeating invoice: its cadence, how the run ends, the payment window, or the memo.
updateRoom write Rename a room or change its capacity or notes.
updateVariant write Edit ONE product variant (a price tier / SKU) in place: name, price (minor units), SKU, and availability.
vetTemplatePackage write Vet a submitted Exchange listing and record the decision: approve it or reject it.
voidGiftCard writedestructive Void ONE gift card: the remaining balance immediately stops being spendable, and whoever is holding the card cannot use it.
voidOrderDocument writedestructive Void a generated document so it can no longer be sent or signed.