get_recurring_order_logs
ChatGPTHelps troubleshoot recurring order issues by fetching relevant logs from GCP. Given an Ordergroove public order id, it retrieves logs related to recurring order attempts. An optional timestamp can be provided to narrow down the search. Please ask the user for a date and time. If the user provides a date and time then convert it to the following format: 'YYYY-MM-DDTHH:MM:SSZ' before passing it in as a timestamp parameter. If the user just provides a date then just pass in the date parameter and the tool will search for logs within a 24 hour period of that date.
get_subscription_creation_logs
ChatGPTHelps troubleshoot subscription creation issues by fetching relevant logs from GCP. Given a Order ID, it retrieves logs related to subscription creation attempts. An optional timestamp can be provided to narrow down the search. Please ask the user for a date and time. If the user provides a date and time then convert it to the following format: 'YYYY-MM-DDTHH:MM:SSZ' before passing it in as a timestamp parameter. If the user just provides a date then just pass in the date parameter and the tool will search for logs within a 24 hour period of that date.
ordergroove_analytics_list_metrics
ChatGPTReturns the Ordergroove Analytics metric catalog: every metric the API exposes, with its identifier, human-readable name, and short description. Call this when the user asks an open-ended analytics (revenue) question and you are unsure which metric to query. The response is small (a handful of entries) and safe to inspect inline; you do not need to paginate or filter it. Typical flow: 1. ordergroove_analytics_list_metrics to discover available metric identifiers. 2. If you're unsure about the metric schema, call ordergroove_get_analytics_metric_schema with the chosen identifier to confirm supported parameters. 3. Call ordergroove_get_analytics_revenue to fetch the data. DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_get_analytics_metric_schema
ChatGPTReturns the schema for a single Ordergroove Analytics metric: its name, description, type, and the lists of dimensions, comparison modes, and flags supported by that metric's data endpoint. Call this before ordergroove_get_analytics_revenue if you are unsure about the metric schema or if you've already called ordergroove_get_analytics_revenue but received a response pointing you to an invalid parameter. Arguments: - metric (string) — one of: - revenue_total - revenue_new - revenue_recurring - revenue_recurring_cross_sell - revenue_one_time_cross_sell DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_get_analytics_order_count
ChatGPTReturns one of the five Ordergroove order-count metrics for a merchant over an inclusive date range, optionally grouped by a time dimension and/or product_external_id, and optionally compared to a prior period. Sourced from the Ordergroove Analytics API. Metrics (pass the value verbatim as metric): - orders_successful — orders that were charged successfully. - orders_recovered — orders that failed initially but were subsequently retried and charged successfully. - orders_rejected — orders that failed and were not recovered. - orders_in_retry — orders currently in the retry queue. - orders_unsent — orders currently unsent. Arguments: - metric (string) — one of the five values above. - from_date / to_date (string, YYYY-MM-DD) — inclusive date range. - group_by (string, optional) — one time dimension (day, week, month, year), product_external_id, or a comma-separated pair of exactly one of each, e.g. day,product_external_id. Pairing two non-time dimensions is NOT supported. - compare_to (string, optional) — prior_period, prior_year, or an explicit YYYY-MM-DD,YYYY-MM-DD range. - limit (integer, optional, 1–1000) — page size. ONLY valid when group_by is set. Server default is 100. - cursor (string, optional) — opaque pagination cursor. Pass back the pagination.next_cursor from a previous response to fetch the next page; do not construct one by hand. Filter (optional): - external_product_ids (string, optional) — comma-separated external product IDs to filter by. Required group_by: product_external_id. Response shapes: without group_by the API returns response_shape: "total" with a single total field; with group_by it returns response_shape: "grouped" with a data array of {dimension, value} entries, plus optional comparison and pagination blocks. The responses also include a is_finalized flag which indicates if all orders that were placed in the given period are in a final state (true) or if there are any orders still in retry (false). Use this for order volume and failure-rate questions. For revenue totals use ordergroove_get_analytics_revenue instead. DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_get_analytics_revenue
ChatGPTReturns one of the five Ordergroove revenue metrics for a merchant over an inclusive date range, optionally grouped by a time and/or non-time dimension (product_external_id, subscription_category or subscription_frequency) and optionally compared to a prior period. Sourced from the Ordergroove Analytics API. Metrics (pass the value verbatim as metric): - revenue_total — all subscription sales (first-time + recurring). - revenue_new — first-time subscription orders only. - revenue_recurring — recurring (non-first) subscription orders only. - revenue_recurring_cross_sell — cross-sell items added to recurring orders. - revenue_one_time_cross_sell — cross-sell items added to one-time / first orders. Arguments: - metric (string) — one of the five values above. - from_date / to_date (string, YYYY-MM-DD) — inclusive date range. - group_by (string, optional) — one time dimension (day, week, month, year), one non-time dimension (product_external_id, subscription_category, subscription_frequency), or a comma-separated pair combining exactly one of each, e.g. day,product_external_id or subscription_category,week. Pairing two non-time dimensions is NOT supported. - compare_to (string, optional) — prior_period, prior_year, or an explicit YYYY-MM-DD,YYYY-MM-DD range. - local_currency (boolean, default false) — when true, return amounts in the merchant's local currency; otherwise USD. - limit (integer, optional, 1–1000) — page size. ONLY valid when group_by is set. Server default is 100. - cursor (string, optional) — opaque pagination cursor. Pass back the pagination.next_cursor from a previous response to fetch the next page; do not construct one by hand. Filters (mutually exclusive — set at most one): - external_product_ids (string, optional) — comma-separated external product IDs (e.g. Shopify variant IDs). Required group_by: product_external_id. - subscription_categories (string, optional) — comma-separated categories, e.g. prepaid,standard. Required group_by: subscription_category. - subscription_frequencies (string, optional) — comma-separated frequencies in days, e.g. 30,60,90. Required group_by: subscription_frequency. Response shapes: without group_by the API returns response_shape: "total" with a single total field; with group_by it returns response_shape: "grouped" with a data array of {dimension, value} entries, plus optional comparison and pagination blocks. Use this for top-line and breakdown revenue questions — not for per-subscription or per-order revenue (use the ordergroove_search_* tools for those). DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_get_analytics_subscriber_count
ChatGPTReturns one of the four Ordergroove subscriber-count metrics for a merchant over an inclusive date range, optionally grouped by a time dimension, and optionally compared to a prior period. Sourced from the Ordergroove Analytics API. Metrics (pass the value verbatim as metric): - subscribers_created — subscribers that created a subscription in the period. - subscribers_reactivated — subscribers that reactivated a subscription in the period. - subscribers_cancelled — subscribers that cancelled a subscription in the period. - subscribers_active — subscribers that had an active subscription in the end of the period - this metric is not additive. Arguments: - metric (string) — one of the four values above. - from_date / to_date (string, YYYY-MM-DD) — inclusive date range. - group_by (string, optional) — one time dimension (day, week, month, year). - compare_to (string, optional) — prior_period, prior_year, or an explicit YYYY-MM-DD,YYYY-MM-DD range. - limit (integer, optional, 1–1000) — page size. ONLY valid when group_by is set. Server default is 100. - cursor (string, optional) — opaque pagination cursor. Pass back the pagination.next_cursor from a previous response to fetch the next page; do not construct one by hand. Response shapes: without group_by the API returns response_shape: "total" with a single total field; with group_by it returns response_shape: "grouped" with a data array of {dimension, value} entries, plus optional comparison and pagination blocks. Use this for subscriber volume and program increase/decrease questions. DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_get_analytics_subscription_count
ChatGPTReturns one of the four Ordergroove subscription-count metrics for a merchant over an inclusive date range, optionally grouped by a time dimension and/or product_external_id, and optionally compared to a prior period. Sourced from the Ordergroove Analytics API. Metrics (pass the value verbatim as metric): - subscriptions_created — subscriptions that were created in the period. - subscriptions_reactivated — subscriptions that were reactivated in the period. - subscriptions_cancelled — subscriptions that were cancelled in the period. - subscriptions_active — subscriptions that were active in the end of the period - this metric is not additive. Arguments: - metric (string) — one of the four values above. - from_date / to_date (string, YYYY-MM-DD) — inclusive date range. - group_by (string, optional) — one time dimension (day, week, month, year), product_external_id, or a comma-separated pair of exactly one of each, e.g. day,product_external_id. Pairing two non-time dimensions is NOT supported. - compare_to (string, optional) — prior_period, prior_year, or an explicit YYYY-MM-DD,YYYY-MM-DD range. - limit (integer, optional, 1–1000) — page size. ONLY valid when group_by is set. Server default is 100. - cursor (string, optional) — opaque pagination cursor. Pass back the pagination.next_cursor from a previous response to fetch the next page; do not construct one by hand. Filter (optional): - external_product_ids (string, optional) — comma-separated external product IDs to filter by. Required group_by: product_external_id. Response shapes: without group_by the API returns response_shape: "total" with a single total field; with group_by it returns response_shape: "grouped" with a data array of {dimension, value} entries, plus optional comparison and pagination blocks. Use this for subscription volume and program increase/decrease questions. DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_get_customer
ChatGPTRetrieves an Ordergroove customer record via the Ordergroove REST API. The merchant_user_id argument is the merchant's OWN user ID for the customer (not an Ordergroove public ID and not a Shopify gid://); preserve it verbatim including any leading zeros. The response is intentionally a NON-PII subset of the customer record. Only these fields are returned: merchant_user_id, phone_type, locale, price_code, created, updated, live. Names, email, phone number, addresses, and free-form merchant extra_data are intentionally OMITTED — if a caller asks "who is this customer?" by name or email, this tool cannot answer; do not hallucinate. Use this tool to confirm whether a customer exists, when they signed up, what locale/price tier they're on, and whether their account is live. DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_get_order
ChatGPTRetrieves the Order information from Ordergroove for a given order ID. The order_id argument is the Ordergroove order public ID (a string; do not strip leading zeros and do not use Shopify gid:// IDs). The response includes order status, totals (subTotal, taxTotal, shippingTotal, discountTotal, total, currencyCode), placement and cancellation timestamps, all line items with their products, components, and per-item subscription details, plus any applied one-time incentives. PII fields (customer name/email/phone, billing address street lines, full card numbers/holders) are intentionally omitted; geographic fields (city, state, zip, country) are returned on shipping/billing addresses for support context. DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_get_product
ChatGPTRetrieves a single product from the Ordergroove REST API by the merchant's product ID. The product_id argument is the merchant's product identifier (snake_case external_product_id in the Ordergroove docs); preserve it verbatim including any leading zeros, and do not use Shopify gid:// IDs. - live (bool) - indicates stock availability in Ordergroove; not necessarily the same as Shopify inventory status. - product_type (string) - one of standard, rotating, static price bundle, dynamic price bundle. - group_name (string) - the product's group name, if any; used for grouping rotating products. - group_type (string) - the product's group type, if any; used for grouping rotating products. - autoship_enabled (bool) - whether the product is enabled for subscription orders. - autoship_by_default (bool) - whether the product is on by default for subscription orders. Set include_product_selection_rules=True only if you're investigating a rotating product and need its product_selection_rules list and selection_list_elements. For standard products this flag has no effect. DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_get_product_relationships
ChatGPTLists the relationships for a single Ordergroove product — parent/child links, bundle components, related products, etc. The product_id argument is the merchant's product ID (same format as Get Ordergroove Product Information). Optional filters: - type (string) — narrow the result to a single relationship type. The accepted values are documented at https://developer.ordergroove.com/reference/product-relationships; leave unset to return every relationship type. Pagination follows the same cursor pattern as Search Ordergroove Products (50-page cap, next URL on has_more=true, resume via after). In practice the relationship list per product is small enough that the cap rarely matters. DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_get_subscription
ChatGPTRetrieves the Subscription information from Ordergroove for a given subscription ID. The subscription_id argument is the Ordergroove subscription public ID (a string; do not strip leading zeros and do not use Shopify gid:// IDs). The response includes identity (publicId, merchantOrderId, externalId, sessionId, extraData), cadence (every, everyPeriod, frequencyDays, reminderDays), commercial info (quantity, price, currencyCode), lifecycle timestamps (startDate, created, updated, cancelled), full cancellation context (cancelReason and structured cancelReasonCode with code + reason), the primary product, queued actions (upcoming skips/processing), and prepaid + free-trial subscription context where applicable. nextOrderDate is the date of the subscription's upcoming unsent order (YYYY-MM-DD); it is null when the subscription is not live or has no order scheduled. It is returned by default. That date is not stored on the subscription — it is read from the subscription's unsent order, which costs one extra lookup — so pass include_next_order_date=False when you know you do not need it, and the field is then omitted entirely rather than returned as null. Geographic-only address fields (city, state, zip, country) are returned on shipping/billing addresses; payment returns brand (ccType) and expiration (ccExpDate) plus system fields, but not the cardholder name or card-number ending. PII fields (customer name/email/phone, full street addresses, gift grantee names) are intentionally omitted. extraData is merchant-supplied free-form metadata and is returned with PII masked — values under keys that look like a name, email, phone, address or credential come back as [REDACTED], and emails / card numbers embedded in other values come back as [REDACTED_EMAIL] / [REDACTED_CARD]. Treat those placeholders as "value withheld", never as the real value: do not report them to the user as data, and never echo them back into ordergroove_update_subscription's new_extra_data — that would overwrite the merchant's real metadata with the mask. DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_search_customers
ChatGPTSearches Ordergroove customers via the Ordergroove REST API and returns the same NON-PII subset per match as Get Ordergroove Customer Information (no names, email, phone, addresses, or merchant extra_data — those are stripped before return; do not hallucinate them). Supported filters (all optional, all from https://developer.ordergroove.com/reference/customers-list): - live (bool) — true for active accounts only. - email (string) — exact match on email address. - created (date, YYYY-MM-DD) — exact match on signup date. - created_start / created_end (date, YYYY-MM-DD) — signup date range. - updated (date, YYYY-MM-DD) — exact match on last-update date. - updated_start / updated_end (date, YYYY-MM-DD) — update date range. Pagination is cursor-based via the response's next URL. The tool auto-paginates up to a per-call page cap and returns {customers, pages_fetched, next, has_more, next_call_hint}. To fetch the next batch, re-invoke this tool with the same filters plus after=<value of next>. DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_search_offers
ChatGPTLists Ordergroove offer profiles (incentives / promotions) via the Ordergroove REST API. Each entry describes a discount, gift, or other promotion configured on the merchant — coupon codes, discount values, target conditions, etc. There is no per-offer retrieve endpoint; this list is the only way to inspect offer configuration. Response will include object and field categorizations: Object choices: order = 1, item = 2 Field choices: total price = 1, shipping total = 2, sub total = 3 By default the request includes offer_profile_category=all_with_standard_flex_incentives, which surfaces both legacy offer profiles and Standard Flex Incentives (SFI) offers. Setting offer_profile_category is NOT EXPECTED for typical troubleshooting — leave it unset unless the user has explicitly asked to filter to or exclude SFI offers, in which case the caller-supplied value is honored verbatim. Supported filters (all optional, from https://developer.ordergroove.com/reference/offer-profile-list): - offer_profile_category (string) — all, all_with_standard_flex_incentives (default), or only_with_standard_flex_incentives. - status (string) — available (server default), archived, or all. Pagination is cursor-based via the response's next URL. The tool walks every page automatically (no per-call page cap; the offer list is bounded). Returns {offers, pages_fetched, next, has_more}. To resume a previously-interrupted call, pass the URL stored in next as after. DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_search_orders
ChatGPTSearches Ordergroove orders using one or more optional filter fields and returns the same per-order fields as Get Ordergroove Order Information for each match. At least one scoping filter is required (customer, subscription, status, place, place_start, or place_end); pagination args alone are not enough. Response will include object and field categorizations: - object choices: order = 1, item = 2 - field choices: total price = 1, shipping total = 2, sub total = 3 Supported filters (all optional, all from Ordergroove's GraphQL orders query at http://developer.ordergroove.com/page/graphql-orders): - customer (string) — filter by Ordergroove customer public ID. - subscription (string) — filter by Ordergroove subscription public ID. - status (list[int]) — filter by one or more numeric order status codes (see the Ordergroove docs for the status code table; do not invent values). - place (string, YYYY-MM-DD) — exact placement date. - place_start (string, YYYY-MM-DD) — orders placed on or after. - place_end (string, YYYY-MM-DD) — orders placed on or before. - include_prepaid_orders (bool) — defaults to true on the server when omitted; pass false to exclude prepaid orders. Pagination is GraphQL Relay-style cursors: - first + after to paginate forward, or - last + before to paginate backward. The response shape is { data: { orders: { edges: [{ cursor, node }], pageInfo: { hasNextPage, hasPreviousPage, startCursor, endCursor } } } }. To fetch the next page, re-invoke this tool with the same filters plus after=<endCursor>. Response shaping (optional): - included_fields (list[str]) — dot-notation paths limiting which fields to return per order, e.g. ["publicId", "items.publicId", "items.quantity"]. Use this to keep responses small when you only need a few fields. Omit included_fields to receive the full payload (default). - Top-level groups available: publicId, status, place, created, updated, cancelled, subTotal, taxTotal, shippingTotal, discountTotal, total, currencyCode, tries, locked, hasPlan, genericErrorCount, oosFreeShipping, rejectedMessage, orderMerchantId, merchantPublicId, shippingAddress, payment, items, oneTimeIncentives. Unknown paths are silently dropped when at least one valid path remains; passing an empty list, or a list where all provided paths are unknown, raises an error. - The oneTimeIncentives.incentive field is a union type — it is all-or-nothing (include it whole, or omit it). - Examples: • included_fields=["publicId", "status", "total"] — IDs + status + total only. • included_fields=["publicId", "items.product.name", "items.quantity"] — order ID plus line-item product names and quantities. All IDs are Ordergroove public IDs (do not use Shopify gid:// IDs). DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_search_products
ChatGPTSearches Ordergroove products via the REST API. By default returns only autoship-enabled, non-discontinued products — use the filters below to broaden the scope. Supported filters (all optional, from https://developer.ordergroove.com/reference/products-list): - search (string) — substring match against the field selected by fields. - fields (string) — which field search matches against; one of name, sku, external_product_id. - id_or_name (string) — case-insensitive partial match against product ID or name. - autoship_enabled (string) — special tri-state: "all" to include both, "false" to fetch only non-autoship products, leave unset for the default (autoship-enabled only). - allow_discontinued (string) — special tri-state: "true" to include discontinued, "strict" to fetch only discontinued, leave unset for the default (exclude discontinued). - group_name (string) — exact group name. - group_type (string) — exact group type. - autoship_by_default (bool) — filter by autoship-by-default flag. - live (bool) — true for products which are currently in stock - external_product_ids (list of strings) — fetch a specific set of products by their merchant IDs (sent as repeated external_product_ids[] query params). - product_type (string) — one of standard, rotating, static price bundle, dynamic price bundle. - include_product_selection_rules (bool) — only meaningful for rotating products; expands their selection rules. Pagination is cursor-based via the response's next URL. The tool walks up to 50 pages per call; if more remain, the response carries has_more=true, the cursor URL in next, and a next_call_hint. Resume by passing that URL as after. DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
ordergroove_search_subscriptions
ChatGPTSearches Ordergroove subscriptions and returns the same per-subscription fields as Get Ordergroove Subscription Information for each match. All filters are optional, but if live is set then customer must also be set (per the API contract). Without any filter, the query returns the merchant's subscription list — bound the result with first if you don't intend to scan everything. Supported filters (from Ordergroove's GraphQL subscriptions query at https://developer.ordergroove.com/page/graphql-subscriptions): - customer (string, optional) — Ordergroove customer public ID. - live (bool, optional) — true for active subscriptions, false for inactive/cancelled. Requires a customer scope. - product (string, optional) — Ordergroove product ID (NOT a Shopify gid://). Finds subscriptions tied to that product. This is the only way to search by product; set it whenever the request is "which subscriptions include product X?". Combinable with customer / live. Pagination is GraphQL Relay-style cursors: - first + after to paginate forward, or - last + before to paginate backward. The response shape is { data: { subscriptions: { edges: [{ cursor, node }], pageInfo: { hasNextPage, hasPreviousPage, startCursor, endCursor } } } }. To fetch the next page, re-invoke this tool with the same filters plus after=<endCursor>. When product is set the search runs against Ordergroove's REST endpoint (the GraphQL API has no product filter) and the result is reshaped into the exact same envelope above, so node fields and the PII exclusions are unchanged. On this path only: after is a REST resume cursor (a URL, surfaced as next_call_hint/endCursor) and Relay first/last/before do not apply; results are page-capped and hasNextPage signals more. Context REST can't supply (product/payment/address details, queuedActions) is fetched automatically, so you can request any included_fields freely. Response shaping (optional): - included_fields (list[str]) — dot-notation paths limiting which fields to return per subscription, e.g. ["publicId", "live", "product.name"]. Use this to keep responses small when you only need a few fields. Omit included_fields to receive the full payload (default). - Top-level groups available: publicId, merchantPublicId, merchantOrderId, externalId, extraData, live, sessionId, every, everyPeriod, frequencyDays, reminderDays, quantity, price, currencyCode, subscriptionType, offerPublicId, startDate, created, updated, cancelled, cancelReason, cancelReasonCode, shippingAddress, payment, product, queuedActions, prepaidSubscriptionContext, freeTrialSubscriptionContext, nextOrderDate. Unknown paths are silently dropped when at least one valid path remains; passing an empty list, or a list where all provided paths are unknown, raises an error. - nextOrderDate REQUIRES EXTRA PROCESSING: unlike every other field it is not part of the subscription record, so it costs one additional orders lookup for each live subscription in the result. Only request it when the next order date is actually needed — never "just in case". It is null for non-live subscriptions (they have no upcoming order) and for live ones with nothing scheduled, and requesting it also adds publicId and live to the response, which are needed to resolve it. - Every nested group is fully drillable (e.g. payment.ccType, product.name, prepaidSubscriptionContext.renewalBehavior); there are no union / all-or-nothing fields on subscriptions. - Examples: • included_fields=["publicId", "live", "startDate"] — IDs + active flag + start date only. • included_fields=["publicId", "prepaidSubscriptionContext.renewalBehavior"] — subscription ID plus the prepaid renewal behavior. All IDs are Ordergroove public IDs (do not use Shopify gid:// IDs). DO NOT set the restapi_jwt_token parameter. It exists in the schema for internal use only and is injected automatically by the server's authentication layer. Any value supplied by the caller will be ignored and overwritten.
shopify_get_billing_attempt_information
ChatGPTRetrieves the Subsciription Billing Attempt information from Shopify for a given billing attempt ID and shop domain. The billing attempt id is converted to the proper shopify GraphQL format so we can accept the full shopify format or just the id portion. The format for the Shopify billing attempt ID is: gid://shopify/SubscriptionBillingAttempt/<id>.
shopify_get_customer_information
ChatGPTRetrieves the Customer information from Shopify for a given customer ID The customer id is converted to the proper shopify GraphQL format so all we need is the id as it appears in ordergroove or Shopify.
shopify_get_merchant_configuration
ChatGPTRetrieves the merchant's Ordergroove<>Shopify integration configuration: the allowlisted feature flags and settings that control how Ordergroove operates for this store (e.g. active payment gateway, capture timing, test mode, prepaid / billing-cycle flags, product-sync config, webhook and onboarding toggles). Use this to diagnose why a merchant's subscriptions/orders behave a certain way, confirm whether a feature is enabled for the store, or verify configuration before escalating an issue. The response is an object with two maps, featureFlags and settings; each entry is { "value": <current value>, "description": <what it controls> }. Only non-secret, allowlisted keys are returned — credentials, access tokens, and gateway secrets are never exposed. This tool needs no identifiers beyond authorization.
shopify_get_order_information
ChatGPTRetrieves the Order information from Shopify for a given order ID. The order id is converted to the proper shopify GraphQL format so all we need is the id as it appears in ordergroove or Shopify. The full format for the Shopify order ID is: gid://shopify/Order/<id>.
shopify_get_product_variant_information
ChatGPTRetrieves the Product Variant information from Shopify or a given product variant ID. The product variant id is converted to the proper shopify GraphQL format so all we need is the product id as it appears in ordergroove or Shopify. Ordergroove associates all of it's products with variant ids, we never use the actual Shopify parent product id in our system.
shopify_get_subscription_contract_information
ChatGPTRetrieves the Subscription Contract information from Shopify for a given subscription contract ID. The subscription contract id is converted to the proper shopify GraphQL format so we can accept the full shopify format or just the id portion. The full format for the Shopify subscription contract ID is: gid://shopify/SubscriptionContract/<id>.
shopify_search_customers
ChatGPTSearches Shopify customers using one or more optional filter fields and returns the same per-customer fields as the Get Shopify Customer Information tool for each match. At least one filter is required. Supported filters (all optional, all from Shopify's customer search syntax): default (free-text across multiple fields), email, first_name, last_name, phone, country, state, tag, tag_not, accepts_marketing (bool), id, customer_date, updated_at, order_date, last_abandoned_order_date, orders_count, total_spent. Date and numeric filters accept Shopify search-syntax operators when passed as strings starting with a comparator, e.g. customer_date='>=2025-01-01' or orders_count='>=5'; otherwise values are treated as exact matches. The tool paginates automatically up to 100 customers per call (page size 25, max 4 pages) and waits between pages so the store's query-cost bucket never drops below 50% of capacity, leaving headroom for other Ordergroove app traffic. If more results exist, the response includes last_cursor and has_more=true; re-invoke this tool with the same filters plus after=<last_cursor> to fetch the next batch.
shopify_search_orders
ChatGPTSearches Shopify orders using one or more optional filter fields and returns the same per-order fields as the Get Shopify Order Information tool, plus the order id, for each match. At least one filter is required. Supported filters (all optional, all from Shopify's orders search syntax): cart_token, channel, channel_id, chargeback_status, checkout_token, confirmation_number, created_at, credit_card_last4, current_total_price, customer_id, delivery_method, discount_code, email, financial_status, fraud_protection_level, fulfillment_location_id, fulfillment_status, gateway, id, location_id, name, payment_id, payment_provider_id, po_number, processed_at, reference_location_id, return_status, risk_level, sales_channel, sku, source_identifier, source_name, status, subtotal_line_items_quantity, tag, tag_not, test (bool), total_weight, updated_at. Plus default (free-text catch-all across multiple fields, also useful for metafield filtering, e.g. default='metafields.custom.foo:bar'). Date and numeric filters accept Shopify search-syntax operators when passed as strings starting with a comparator, e.g. created_at='>=2025-01-01' or current_total_price='>=100.00'; otherwise values are treated as exact matches. The tool paginates automatically (page size 10, max 5 pages, up to 50 orders per call) and waits between pages so the store's query-cost bucket never drops below 50% of capacity, leaving headroom for other Ordergroove app traffic. If more results exist, the response includes last_cursor and has_more=true; re-invoke this tool with the same filters plus after=<last_cursor> to fetch the next batch. Response shaping (optional): - included_fields (list[str]) — dot-notation paths limiting which fields to return per order, e.g. ["id", "name", "totalPriceSet"]. Use this to keep responses small when you only need a few fields. Omit included_fields to receive the full payload (default). Lead with id if you want to correlate the returned orders. - Top-level groups available: id, name, createdAt, totalPriceSet, app, billingAddress, billingAddressMatchesShippingAddress, cancellation, cancelledAt, cancelReason, capturable, closed, confirmationNumber, confirmed, currencyCode, currentCartDiscountAmountSet, currentShippingPriceSet, currentSubtotalPriceSet, customAttributes, customer, discountCodes, displayFinancialStatus, displayFulfillmentStatus, edited, lineItems, note, originalTotalPriceSet, paymentGatewayNames, presentmentCurrencyCode, productNetwork, requiresShipping, shippingAddress, shippingLine, sourceName, tags, updatedAt. Unknown paths are silently dropped when at least one valid path remains; passing an empty list, or a list where all provided paths are unknown, raises an error. - Every nested group is fully drillable, e.g. totalPriceSet.presentmentMoney.amount, lineItems.variantTitle, lineItems.variant.id; there are no union / all-or-nothing fields. - Examples: • included_fields=["id", "name", "totalPriceSet"] — id + name + total price only. • included_fields=["id", "lineItems.variantTitle", "lineItems.variant.id"] — order id plus line-item variant titles and variant ids.
shopify_search_product_variants
ChatGPTSearches Shopify product variants using one or more optional filter fields and returns the same per-variant fields as the Get Shopify Product Variant Information tool, plus the variant id, for each match. At least one filter is required. Supported filters (all optional, all from Shopify's productVariants search syntax): default (free-text across multiple fields), barcode, collection, delivery_profile_id, exclude_composite (bool), exclude_variants_with_components (bool), gift_card (bool), id, inventory_quantity, location_id, managed (bool), managed_by, option1, option2, option3, product_id, product_ids, product_publication_status, product_status, product_type, publishable_status, published_status, requires_components (bool), sku, tag, tag_not, taxable (bool), title, updated_at, vendor. Numeric and date filters accept Shopify search-syntax operators when passed as strings starting with a comparator, e.g. inventory_quantity='>=10' or updated_at='>=2025-01-01'; otherwise values are treated as exact matches. The country_code parameter (default 'US') is used to look up contextual pricing per variant. The tool paginates automatically (page size 10, max 5 pages, up to 50 variants per call) and waits between pages so the store's query-cost bucket never drops below 50% of capacity, leaving headroom for other Ordergroove app traffic. If more results exist, the response includes last_cursor and has_more=true; re-invoke this tool with the same filters plus after=<last_cursor> to fetch the next batch.