Your assistant picks tools automatically from your request, so you do not need to name them; you can name one when you want to be specific, such as “use list_claims.” Tools marked Write change data; everything else only looks it up. Name a shop in your request, or ask for list_shops when you need a shop ID.
Shops and settings
list_shops(Read) — Lists every shop you can access. You can search by shop name or domain and limit the number of results.get_shop_settings(Read) — Shows about 100 shop configuration options across billing, widgets, shipping, returns, claims, and more. Needsshop_id.update_shop_settings(Write) — Changes only the shop settings you provide and leaves other settings unchanged. Needsshop_idand asettingsobject.
Orders
list_orders(Read) — Lists and searches orders by order details, customer details, or tracking numbers. You can filter by date, insurance status (insuredoruninsured), refund status (refundedornot_refunded), return status (returned,return_in_progress, ornot_returned), editing status (editedornot_edited), protection source (customer,merchant, ormerchant_auto), and order type (checkoutorrecurring).get_order(Read) — Shows an order’s financial and fulfillment status, line items, protection, customer, addresses, shipments, claims, returns, and refunds. Needsid.protect_order(Write · requires Checkout+) — Adds merchant-funded Checkout+ protection to an eligible order that was not protected at checkout. Needsid.
Customers
list_customers(Read) — Lists and searches customers by name, email, or your shop’s customer ID. You can narrow results by shop and use cursor pagination.get_customer(Read) — Shows a customer’s contact information, fraud and redaction status, default address, orders, CashBack balance, claims, returns, and customer score. Needsid.
Package protection claims (Checkout+)
These tools require Checkout+ to be enabled on the shop.
list_claims(Read) — Lists and searches package protection claims by claim key, order, or customer. You can filter by claim status (in_progress,unqualified,on_hold,pending_merchant_action,resolved, ordenied), status reason, cause (stuck_in_transit,damaged,stolen,missing,wrong_item,not_satisfied,returned,chargeback, orlate_delivery), and creation date.get_claim(Read) — Shows a package protection claim’s cause, status, amounts, line items, order, customer, and conversation. Needsid.
CashBack rewards
These tools require CashBack to be enabled on the shop.
list_rewards(Read) — Lists and searches CashBack rewards by discount code or customer. You can filter by usage status, sort results, and paginate through them.
Subscriptions
These tools require Checkout+ to be enabled on the shop.
list_subscriptions(Read) — Lists and searches subscriptions by subscription platform ID or customer email. You can filter by subscription status and paginate through results.toggle_recharge_subscription_insurance(Write) — Enables or disables Checkout+ protection on the next queued charge for a Recharge subscription. Needsidandinsurance_enabled.
Returns
These tools require Returns to be enabled on the shop.
list_return_requests(Read) — Lists and searches return requests by return number, order, or customer. You can filter by processing stage (manual_review,open, orclosed), shipping label state (not_dropped,in_transit,delivered,available_for_pickup,return_to_sender,error,cancelled,voided,expired, ormanual), return type (refund,store_credit, orexchange), and exchange fulfillment status (fulfilled,partial, orrestocked).get_return_request(Read) — Shows a return request’s status, resolution, items, exchange items, shipping, tracking, settlement, amounts, and merchant notes. Needsid.get_return_request_tracking(Read) — Shows return shipping labels, tracking details, return-window deadlines, and tracking events. Needsid.set_return_request_status(Write) — Advances a return request toopen,declined,closed, orcompleted. The result can approve a return, refund or void it, process its resolution, or generate a shipping label. Needsidandstatus;shipment_providercan beship_sidekickormanualwhen approving.remove_return_request_item(Write) — Permanently removes an item and any exchange item tied to it from an open or requested return. Needsid.set_return_request_item_restock(Write) — Sets whether a return item should be restocked after processing. Needsidandrestock.update_exchange_item(Write) — Changes the quantity of a requested exchange item. Settingquantityto0removes it. Needsidandquantity.
Order Editing
These tools require Order Editing to be enabled on the shop.
get_order_editing_settings(Read) — Shows which changes customers can make to placed orders and the change deadline. Needsshop_id.update_order_editing_settings(Write) — Changes only the Order Editing settings you provide and leaves other settings unchanged. Needsshop_idand asettingsobject.get_order_edit_history(Read) — Shows the latest-first history of item, address, quantity, discount, commit, finalize, and cancel events for an order. Needsid.
Track
These tools require Track to be enabled on the shop.
get_track_settings(Read) — Shows Track notification toggles, enrichment options, and the per-package tracking fee. Needsshop_id.update_track_settings(Write) — Changes only the Track settings you provide and leaves other settings unchanged. Needsshop_idand asettingsobject.get_order_tracking(Read) — Shows package carriers, tracking numbers and URLs, delivery status, estimated and actual delivery, tracking events, and package line items. Needsid.
Appearance
get_appearance_settings(Read) — Shows consumer-facing colors, tagline, translations, and Checkout+ widget configuration such as copy, selectors, and powered-by branding. Needsshop_id.update_appearance_settings(Write) — Changes only the Appearance settings you provide. Values such astranslationsandsubheading_overridesmust be JSON-encoded strings. Needsshop_idand asettingsobject.
Write actions
protect_orderadds merchant-funded Checkout+ protection to an eligible order.remove_return_request_itempermanently removes a return item and any exchange item tied to it.set_return_request_item_restockchanges whether a return item should be restocked after processing.toggle_recharge_subscription_insuranceenables or disables protection on a Recharge subscription’s next queued charge.update_appearance_settingschanges Appearance settings and records the change in the settings audit history.update_exchange_itemchanges an exchange quantity and can remove the exchange item when the quantity is0.update_order_editing_settingschanges Order Editing settings and records the change in the settings audit history.set_return_request_statuscan refund, void, process, or generate a shipping label for a return request.update_shop_settingschanges the shop settings you provide and records the change in the settings audit history.update_track_settingschanges Track settings and records the change in the settings audit history.
