accept_topic_replay_variant
ChatGPTFiles a prompt variant that beat the current live settings in a completed topic replay run as one GitHub proposal for engineering, for a staff member who accepts that variant: runId and the revisionId of the variant (get_topic_replay_results gives both). The call returns a preview of the proposal and files nothing; the proposal is filed only after the staff member clicks Confirm in the Confirm card. The proposal keeps the hold label, so a person merges its change, and nothing is applied to live settings or code. A change that is already filed returns its issue with no new preview. Premium plan only.
approve_pending_customer_message
ChatGPTSends a pending customer draft (from @SC or queue_customer_draft) to the customer, for a request to send a drafted reply. clientMessageId (list_pending_customer_drafts gives it) selects the draft when the ticket has more than one. The call returns a preview and changes nothing. The action runs only after the staff member clicks Confirm in the Confirm card. reject_pending_customer_message discards a draft.
approve_staff_proposal
ChatGPTApprove a pending order change or customer record card (proposalId from list_staff_proposals), for a request to approve a card, with notifyCustomer and the staff field of its kind (null keeps the value of the card): holdUntil for an order change card that holds the order, and newPhone for a customer record card that changes the phone number. The preview runs the check of the dashboard card. On approval, ShipHero changes the shipment or Shopify changes the customer; the card leaves the ticket, and a staff note names the staff member who approved it. It does not approve a refund, order cancel or replacement order card, because that approval moves money: the call approves nothing and gives the ticket link, and staff approve the card in the Simple Chat dashboard. The call returns a preview and changes nothing. The action runs only after the staff member clicks Confirm in the Confirm card.
assess_topic_replay_case
ChatGPTRecords the own assessment of the staff member for one replayed conversation of a topic replay run, for a staff member who judges a case: runId, the conversationId of the case (get_topic_replay_results lists the cases), the outcome and, unless the outcome is resolved, the reason. The assessment is kept apart from the automated judgment. Premium plan only.
claim_conversation
ChatGPTClaims a customer conversation for the staff member who connected, for a request to take a ticket. It takes the ticket over from another staff member without a check, leaves a staff-only note and sends nothing to the customer. It returns conversationId and ticketUrl. It cannot remove a claim.
confirm_staff_action
ChatGPTRuns or cancels an action the staff member confirmed or cancelled in the Simple Chat Confirm card.
consult_ticket_staff_agent
ChatGPTRuns the ticket-local @SC staff agent on a customer conversation and returns its internal notes, for a question that needs the ticket agent. On this connection @SC can search the store information, the products and past conversations, look up orders, write staff-only notes and queue customer-visible drafts. On a store with the store browser, it can also open the public website of the store to check a page. It cannot change an order, an address or a setting. A queued draft reaches the customer only after approve_pending_customer_message and the Confirm of the staff member, or after an approval in the dashboard. When @SC still works at the end of the call, stillRunning is true, and its notes come to the ticket later.
delete_suggested_answers
ChatGPTDeletes stored answers of the suggested questions of this shop, for a staff member who asks for the delete. Each entry of answers names an answer by its id and its updatedAt (list_suggested_answers gives both). The call runs at once, with no Confirm card, and a deleted answer cannot come back. The server deletes an answer only when its updatedAt is the version that the entry names: an answer that changed or was deleted after the read stays as it is. It returns deletedIds, the ids of the deleted answers, and notDeletedIds, the ids of the answers of the call that it did not delete; the call fails when it deletes no answer. After the delete of an active answer, the AI answers the question. A later click of the question can store a new draft.
draft_topic_replay_variant
ChatGPTDrafts one topic replay variant from the staff-resolved conversations of an Analytics topic, in two calls, for a request to prepare a change to test; nothing runs. The first call takes the topic (issueType) and covers the last 14 days, or the window in days. It returns an experimentId and the cases of the topic as conversationIds only; get_ticket_context reads a case. The second call takes that experimentId and exactly one variant, in faqVariants or promptVariants (prompt variables only). It saves the variant as an agent-drafted revision and returns its revisionId and its diff. run_topic_replay replays a drafted revision whose revisionId is in draftedRevisionIds. Premium plan only.
get_customer_orders
ChatGPTLoads the Shopify orders of a customer, for a request about the orders of a customer: by customerId, by lookupEmail, or from the orders stored on a ticket (loadFromStoredCustomerContextOnly with a conversationId). It returns the email, numberOfOrders and at most the 20 newest orders, each with name, createdAt, the financial and fulfillment status, and the links that the order has (shopifyAdminUrl, shipHeroUrl and trackingUrl). It does not return the items of an order: the @SC agent of consult_ticket_staff_agent can look up an order of a ticket with its items, and shopifyAdminUrl opens the order in the Shopify admin. With a conversationId, customerId and lookupEmail must belong to the customer of that ticket. Read-only.
get_merchant_settings
ChatGPTReads the store instructions of the customer AI of this shop (its prompt variables), for a request to see or change them. settingIds takes the prompt variables to read, such as prompt_variables.custom_additional_system_context. For each one it returns settingId, label, helpText, storedOverride (the text of the shop, null when the shop uses the default text), hasOverride, sizeChars, budgetChars and overBudget when the prompt variable has a size budget, and, unless includePromptVariableDefaults is false, defaultValue and effectiveValue (the text that the customer AI uses). It reads no other setting. Read-only.
get_product_details
ChatGPTLooks up Shopify product and variant details by variant id (numeric id or GID), for a question about a product variant. No other tool of this connection has a result field with a variant id: search_store_information gives the id of a product, and get_customer_orders does not return the items of an order. The @SC agent of consult_ticket_staff_agent can look up a product, or an order of a ticket with its items, and its notes can give the variant ids that it finds; a staff member can also give the id. It reads Shopify now and returns, for each variant, variantId, title, productTitle, variantTitle, price, imageUrl and requiresShipping. A variant that Shopify does not have is absent from the result. It does not return stock levels. Read-only.
get_reports_summary
ChatGPTGenerates a reports-page summary of the customer conversations that match a filter, for a request about what customers write about. It selects at most 50 conversations of the lookback window that match the filter, without spam, and returns a Markdown summary, the conversationIds that it used, ticketUrls and reportsUrl. A topic filter matches a topic of the Reports page of the Simple Chat dashboard, not an Analytics topic of list_topic_resolution_rates, and no tool of this connection lists the topics of the Reports page. When no conversation matches the filter, the summary says so and conversationIds is empty. Read-only; it does not change a ticket status. search_messages finds single messages.
get_shopify_subscription_plans
ChatGPTLists the subscription plans (Shopify selling plan groups) that Simple Chat manages for this shop, for a request about the subscription options that shoppers see. Each plan has its id, name, sellingPlanId, sellingPlanName (the name that shoppers see), billingPolicy, deliveryPolicy, discountPercentage, renewalDiscountPercentage (the discount of each order after the first, which makes discountPercentage the discount of the first order only; with null, discountPercentage is the discount of each order), minimumItemPrice, belowMinimumItemPrice, fullPriceGroup, products and productVariants. minimumItemPrice (or null) is the minimum order subtotal of the plan in the shop currency: before each charge, an item with the later-order discount of the plan gets it only when the items of the order cost this amount or more at the store prices. At checkout, only an item that cost this amount or more at the last save of the plan gets the discount of the first order. products and productVariants, not the minimum, tell which items have the plan now: a listed product has the plan on each of its variants, and a listed variant has it. With belowMinimumItemPrice "full-price", a variant that cost less than the minimum at the last save has the plan with no discount on the first order, from the group that fullPriceGroup names, and productVariants lists it too; with "not-offered", it does not have the plan. Each list of the result (the plans, and the products and productVariants of a plan) shows only its first 20 entries. It does not list the plans of other apps. Read-only.
get_ticket_context
ChatGPTReads a customer ticket, for a request about one conversation: its status and aiEnabled, and its messages with full text, oldest first. Each page gives total, hasMore and nextOffset (offset and limit). A message shows at most 8,000 characters, and nextTextOffset continues a longer message. Staff-only notes are included, and a proposal card shows as one line (list_staff_proposals gives its facts). A message with files starts with [Attachment], and then the text that the sender typed. It does not return the files or their names, which the ticket AI sees (an image file, and the name of another file), or the tool calls of the ticket AI, their results or the context of a turn, so an AI reply can hold a fact that no returned message shows. Read-only.
get_topic_replay_results
ChatGPTReads the results of a topic replay run, for a request about how a replay went: its topic (issueType), its cases (conversationIds), how many replays ran, their cost, recurring themes, the projected AI resolution of each variant against the current live settings, and the dashboard report link. runId is the id that the Confirm card reported; without it, the tool reads the newest run that this staff member started with run_topic_replay or rerun_topic_replay_set, and never a run of another staff member. While status is running, the run has no results yet. Premium plan only. Read-only.
leave_internal_note
ChatGPTLeaves a staff-only internal note on a customer ticket, for a staff member who dictates a note. Staff see the note on the ticket. It returns conversationId and ticketUrl. It does not message the customer or change the ticket status.
list_inbox_conversations
ChatGPTLists the customer conversations that the Simple Chat inbox shows, most recent activity first, for a request about what waits in the inbox: open tickets and recently closed ones, without spam. status filters by ticket status, and offset and limit page the list (nextOffset). Read-only.
list_pending_customer_drafts
ChatGPTLists the customer-visible drafts of a ticket (from @SC or queue_customer_draft) that wait for staff approval, for a request about the replies that wait. It returns draftCount and, for each draft, clientMessageId, a textPreview of at most 400 characters and createdAt. Read-only: it does not send or discard a draft.
list_staff_proposals
ChatGPTList the proposal cards that wait for a staff decision, for a request about what waits for approval: refund, order cancel, order change, customer record and replacement order cards. With conversationId, it lists the cards of that ticket. Without it, it lists the cards of the conversations of one inbox page, most recent activity first; page with offset and limit (nextOffset). Each card gives proposalId, kind, orderName, action (what an approval does), amounts with currencyCode (for a replacement order card, the amount due of the prices that the card keeps), basis (why the AI made the card; absent on a card that a person started), aiRecommendation (when the AI gave one), staffFields (the fields that staff can change in the card, with their values now; a replacement order card gives only shipDifferentLot, and staff change its items, address and shipping in the dashboard), the number of the customer files for a tax exemption card, and ticketUrl. A decided card is not listed. Read-only. reject_staff_proposal rejects a card, approve_staff_proposal approves an order change or customer record card, and start_staff_proposal starts a card. Staff approve a refund, order cancel or replacement order card in the Simple Chat dashboard, at the ticketUrl of the card.
list_suggested_answers
ChatGPTLists the stored answers of the suggested questions of this shop (Settings > Suggested answers of the Simple Chat dashboard), for a request to check, approve or clean up these answers. A suggested question is a question that the storefront search box or the chat shows to shoppers. Each answer gives its id, message (the exact question text that a click sends), label (the question as shoppers see it, or null), reply (its parts in order: a text with html in Markdown or HTML, a cta with label and url, or reply_options with labels), status, sent (how many times shoppers got the reply), capturedAt, editedAt (when staff last edited the reply, or null) and updatedAt (its version). With status draft, no shopper gets the reply and the answer waits for staff; a draft that staff did not edit can get a new reply after a later click. With status active, the chat can send the reply as it is to a shopper who clicks the question; in some cases the AI answers the click in place of the stored reply, for example on a checkout page, in a conversation with a staff note, or when a product that the reply links is not for sale. With status off, the AI answers the question. The answers come oldest first; status filters them, and afterId and limit page them (nextAfterId, null on the last page). counts gives the number of answers of each status. Read-only.
list_topic_resolution_rates
ChatGPTLists the Analytics AI resolution by issue type for a window of days, for a request about which topics the AI resolves: for each topic (issueType), the AI-resolved and the staff-resolved conversations and the AI resolution percent. A topic of this list is an issueType for run_topic_replay. Premium plan only. Read-only.
pin_conversation
ChatGPTPins or unpins a customer conversation for the staff member who connected, for a request to keep a ticket in view. Other staff members see no change, and the customer sees nothing. It returns conversationId, ticketUrl and pinned.
queue_customer_draft
ChatGPTQueue a customer-visible draft reply on a customer ticket with the exact text that the staff member gives, for a request to prepare a reply that staff then approve. Nothing reaches the customer until staff approve the draft with approve_pending_customer_message or in the Simple Chat dashboard; reject_pending_customer_message discards it. A staff note names the staff member, and the ticket status does not change. It returns conversationId, ticketUrl and the clientMessageId of the draft. For a reply that @SC writes, use consult_ticket_staff_agent.
reject_pending_customer_message
ChatGPTDiscards a pending customer draft (from @SC or queue_customer_draft), for a request to drop a drafted reply, and sends nothing to the customer. clientMessageId (list_pending_customer_drafts gives it) selects the draft when the ticket has more than one. The call returns a preview and changes nothing. The action runs only after the staff member clicks Confirm in the Confirm card.
reject_staff_proposal
ChatGPTReject a pending refund, order cancel, order change, customer record or replacement order card (proposalId from list_staff_proposals), for a request to decline a card. The card leaves the ticket, and a staff note names the staff member who rejected it; as in the dashboard, the reject of a replacement order card writes no note. Nothing changes in Shopify, and the customer is not messaged. The call returns a preview and changes nothing. The action runs only after the staff member clicks Confirm in the Confirm card.
rerun_topic_replay_set
ChatGPTReplays the frozen cases of a saved topic replay set again, for a request to repeat a saved replay, as a new run of the same set, with the current live settings and the saved variant revisions in revisionIds (save_topic_replay_set returns them; without revisionIds, only the current live settings replay). replayMode replays the customer message at the handoff (the default), the whole conversation (whole_conversation) or the conversation from the first customer message (from_first_message). The call returns a preview of the case count, the variants and the estimated cost, and starts nothing. The rerun makes paid AI calls, so it runs only after the staff member clicks Confirm in the Confirm card, which reports the runId. get_topic_replay_results reads the results of a runId. Premium plan only.
run_topic_replay
ChatGPTReplays the staff-handled conversations of an Analytics topic (issueType) through Simple Chat with the current live settings, and judges each replay against what staff did, for a request to test how the AI handles a topic. The replay covers the last 14 days, or the window in days. includeConversationIds and excludeConversationIds change the sample. replayMode replays the customer message at the handoff (the default), the whole conversation (whole_conversation) or the conversation from the first customer message (from_first_message). faqVariants, fieldVariants and promptVariants each replay beside the current live settings on the same cases, and change no live setting. The call returns a preview of the case count, the variants and the estimated cost, and starts nothing. The replay makes paid AI calls, so it runs only after the staff member clicks Confirm in the Confirm card, which reports the runId. get_topic_replay_results reads the results of a runId. Premium plan only.
save_topic_replay_set
ChatGPTNames the frozen case set of a topic replay, for a request to keep a replay for a later rerun, so that rerun_topic_replay_set can replay it again: experimentId is the id of the replay (get_topic_replay_results gives it), and setName is the name that the staff member gives the set. It returns the saved variant revisions of the set. A name belongs to one set of the shop. Premium plan only.
search_customers
ChatGPTSearches the Shopify customers of this shop by name or email, for a request to identify a person. It returns at most limit customers, each with the Shopify customer id (the customerId of get_customer_orders), email, first name and last name; customers without an email are left out. It does not search ticket messages (search_messages does) and does not return orders. Read-only.
search_messages
ChatGPTSearches the customer-ticket messages of this shop, for a request to find a ticket by a word, a name or an email. The query matches as one exact phrase in message text, customer names and emails. It returns resultCount and at most 20 matches, each with conversationId, a text of at most 200 characters, the customer name and email, and ticketUrl; staff-only notes are included. Read-only; it does not change a ticket status. get_ticket_context reads a full ticket.
search_store_information
ChatGPTSearches the FAQs, articles and imported store knowledge of this shop, for a question about a store policy, a product fact or a how-to. queries takes one to three concise English search phrases, and record_refs reads exact records again by type and id (an earlier result gives the id). It returns the matching FAQs (id, question, answer, and the usage instructions of the store when the FAQ has them), articles (id, title, url, summary and body) and store knowledge records (id, type and fields), and the current catalog products that the search matched or that record_refs names (id, title and url). The tool returns no FAQ that is not active now, by queries or by record_refs, and a search by queries does not always return an announcement. coverageIncomplete is true when a requested record was not available or the search did not examine all records. Read-only.
set_merchant_ticket_status
ChatGPTSets the ticket status of a customer conversation to triage, awaiting-staff or monitoring, for a request to move a ticket. The status awaiting-staff clears the follow-up and starts a staff-admin escalation review; monitoring turns the AI on and schedules a follow-up. It returns status, scheduledFollowUp, aiEnabled and ticketUrl, and it sends nothing to the customer. It cannot close a ticket.
start_staff_proposal
ChatGPTStart a refund, order cancel, order change or customer record card for an order of the ticket, for a request to prepare such a change, as staff do from the order list of the dashboard (orderName from get_customer_orders with loadFromStoredCustomerContextOnly). The card has the values of a card that a person starts: a refund card selects the whole order (with refundAmount, it refunds only that amount), a cancel card refunds to the original payment method and restocks, and a hold card or a phone card waits for the date or the number that staff set when they approve it. It has no AI basis. Nothing changes in Shopify or ShipHero, the ticket status does not change, and a staff note names the staff member. A ticket has one card of each kind for each order (one customer record card for each customer). list_staff_proposals shows the new card. reject_staff_proposal rejects it, and approve_staff_proposal approves an order change or customer record card; staff approve a refund or order cancel card in the Simple Chat dashboard. A replacement order card is started in the dashboard: its start sets the ticket to awaiting-staff, starts an escalation review and has no limit of one card for each order.
update_merchant_settings
ChatGPTChanges the FAQs and the store instructions (prompt variables) of the customer AI of this shop, for a staff member who asks for the change. faqUpserts edits an FAQ by its id, or adds an FAQ when id is null (an add that repeats an FAQ of the shop adds no copy), with its question, answer and optional fields such as usageInstructions; clearFields removes optional fields. updates sets each prompt variable (settingId prompt_variables.<key>) to its whole new text, as a JSON string in valueJson, or to null for the default text; get_merchant_settings reads the current text. The customer AI uses the change at once. It returns updatedSettingIds. It changes no other setting and deletes no FAQ.
update_subscription_plan_settings
ChatGPTChanges the settings of a subscription plan that Simple Chat manages (id from get_shopify_subscription_plans), for a request of a staff member: its name, its schedule, the discount of the first order, the discount of each order after the first, and the minimum order subtotal. It takes only the settings that change. The server reads the whole plan: each of its variants keeps it, with its order day and cycle limits, and it creates no plan. With a minimum order subtotal, the variants that cost less than the minimum at the save get the plan with no discount on the first order, and each product of the plan becomes its variants, as a save in the dashboard does. A custom schedule plan follows the minimum of its source plan or of the custom schedule settings, so it takes no minimum. A plan that is not offered on the variants below its minimum is changed in the dashboard, and a plan with a pricing rule that the read does not show (an amount off, a fixed price, or a discount from a later order) in Shopify. The preview shows each setting before and after. The call returns a preview and changes nothing. The action runs only after the staff member clicks Confirm in the Confirm card. After the Confirm, shoppers see the change at once and new checkouts use it; before each charge of a subscription of the plan, Simple Chat uses the minimum of the plan at that time. A change of a discount does not change the subscriptions that exist.
update_suggested_answers
ChatGPTApproves, turns off or edits stored answers of the suggested questions of this shop, for a staff member who asks for the change. Each entry of answers names an answer by its id and its updatedAt (list_suggested_answers gives both) and gives a status, a reply or both: status active approves the answer, status off turns it off, and reply stores a whole new reply as a staff edit. A call that only turns answers off or edits answers that are not active runs at once. A call with an entry that leaves its answer active (an approval, or a new reply of an active answer) returns a preview of each such reply and changes nothing; the whole call runs only after the staff member clicks Confirm in the Confirm card, and the chat can then send the reply to shoppers who click the question. The call changes each of its answers or none. The server refuses an entry when the updatedAt of its answer is not the version that the entry names, when its reply cannot go out, or when it changes nothing; the call then fails with the reason of each refused entry. It returns updated: each changed answer with its id, status and new updatedAt. It does not make an answer a draft again and deletes no answer: staff delete an answer in the Simple Chat dashboard.