analytics_preference_get
ChatGPTShow whether optional product analytics is enabled for this account.
analytics_preference_set
ChatGPTEnable or disable optional product analytics for this account.
cart_clear
ChatGPTClear the authenticated customer cart.
cart_get
ChatGPTRead the authenticated customer cart and its current price quotes.
cart_remove_item
ChatGPTRemove one exact item/configuration line from the cart.
cart_set_item
ChatGPTSet the exact cart line quantity and wholesale selection. This overwrites the quantity and wholesale setting for the same itemId/configurationId; it does not add to the quantity. Omitting wholesale uses standard pricing. Appends a new line when that itemId/configurationId is not already in the cart. For a supplier preview, first call catalog_get_product and wait for full product details; use only a configuration and buyer offer actually returned there. Current pricing and availability are re-quoted. Returns the updated cart view. Requires cart:write scope. Use cart_remove_item to remove a line.
catalog_get_product
ChatGPTGet product details, offer, attributes, variants, media, and a SuperCheap deep link. When opening a supplier preview, pass its collection, channel, source, and sourceSchemaVersion through this call and later cart/favorite calls. If the item is a supplier preview, this may request background supplier-detail hydration and returns its current status; retry while pending until full product details are available before choosing a configuration or adding it to a cart.
catalog_get_similar_products
ChatGPTFind similar products with stable continuation across catalog and supplier sources. Use nextCursor with the same item and market for subsequent pages. A short page is not exhaustion when continuation is present. If status is pending or supplierExpansion is queued, running, or throttled, retry at retryAfter or supplierRetryAt. Supplier previews must be hydrated with catalog_get_product before choosing a configuration or adding to cart. Present only buyer-market offer prices, never supplier costs.
catalog_report_product_impressions
ChatGPTRecord only products that were actually presented to the shopper. Searching alone does not mark products as viewed. This idempotent impression signal is used to demote or exclude products in later searches.
catalog_search_products
ChatGPTSearch canonical products with category, attribute, price, provider, vendor, sorting, and bounded pagination filters. Attribute pairs are forwarded to supplier discovery as provider Pid/Vid filters when expansion is needed, so keep the exact attributeId/valueId returned by facets. When the shopper requests N products, set limit=N (1–48); leave it unset to use the default of 12 when no count is specified. Set compact=true when limit exceeds 24; compact changes card payload size, not card selection. The product-card UI displays every returned item and supplier preview, up to 24 cards per result. Do not fetch a larger page and then select fewer only in prose: those returned cards still appear in the UI. If the shopper wants only the existing catalog or says not to search suppliers, set expandSuppliers=false so previews are not added. When product-card UI is attached, do not claim product photos are unavailable solely because the text response lacks inline images; refer to the rendered cards. Set freshOnly=true to exclude products already opened or explicitly exposed to this shopper. Use nextCursor for stable exploration pages, or nextOffset when nextCursor is unavailable; keep using the same query and filters. If status is pending, wait until retryAfter and resume with nextCursor as cursor, or nextOffset as offset when no cursor is returned; never restart a pending search from the first page. Supplier discovery automatically runs in the background for missing, weak, or exhausted results unless expandSuppliers=false. A broad result withholds unconfirmed canonical cards and describes only the current page. Continue with nextCursor when present, otherwise nextOffset; zero supplier previews on a page does not mean the search is exhausted. If supplierExpansion is queued, running, or throttled, wait until supplierRetryAt and repeat the same search. Set waitForSupplierResults=true to have the server poll a queued supplier expansion for up to maxWaitMs before returning.
category_get_tree
ChatGPTReturn a bounded category subtree. Use rootCategoryId and maxDepth to avoid loading the entire taxonomy.
category_search
ChatGPTFind canonical SuperCheap categories using lexical and semantic matching.
checkout_create_payment_link
ChatGPTAfter explicit user approval, use the prepared confirmation to create the hosted Stripe payment link. The confirmation is bound to the first idempotencyKey used: if creation fails, retry with the same confirmationId and exact same key; do not switch keys. Replaying after success returns the existing unpaid checkout and link through checkout idempotency without creating another Stripe session.
checkout_get_status
ChatGPTRead the authenticated customer checkout/payment status.
checkout_prepare_payment
ChatGPTCreate a short-lived server confirmation bound to the exact selected cart lines, cart revision, address, shipping option, and currency. Server checks the supplied cartRevision and selectedLines against the live cart, then returns the current quote cartRevision, confirmationId, expiresAt, totalAmountMinor, currencyCode, quote, and selectedShippingOption. Creates no order or charge at this stage. Requires checkout:write scope. After checkout_quote, prepare this confirmation, ask the user to review the returned total and shipping option, then use checkout_create_payment_link only after approval. Pass the selectedLines again with the returned global cartRevision to prepare payment. At payment-link creation, the confirmation is bound to one idempotencyKey: retries must use that same key, and another key is rejected. If the cart changes, payment creation is blocked and checkout must be prepared again.
checkout_quote
ChatGPTQuote only the explicitly selected cart lines and available shipping before asking the user to confirm payment. Copy selectedLines and cartRevision from cart_get; unselected lines stay in the cart. If a selected price needs acceptance, this may update that cart line to the current price and advance the shared cart revision. It does not create an order or initiate a payment.
customer_address_create
ChatGPTSave a delivery address. Never infer missing personal information.
customer_address_delete
ChatGPTDelete one saved delivery address after explicit confirmation.
customer_address_list
ChatGPTList saved delivery addresses for the authenticated customer.
customer_address_update
ChatGPTUpdate one saved delivery address. Required address fields and its default selection are overwritten; optional address line, area, and postal code values are retained when omitted.
favorites_add
ChatGPTAdd one canonical product, optionally with a selected configuration, to favorites. Copy collection, channel, source, and sourceSchemaVersion from the product card when available.
favorites_list
ChatGPTList the authenticated customer favorites in most-recently-saved order.
favorites_remove
ChatGPTRemove one canonical product or selected configuration from favorites. Copy collection, channel, source, and sourceSchemaVersion from the product card when available.
market_list
ChatGPTFind supported SuperCheap country, language, currency, and checkout availability combinations.
orders_confirm_delivery
ChatGPTConfirm that an order was delivered after explicit customer confirmation.
orders_decide_replacement
ChatGPTChoose refund or replacement for an eligible order only after explicit customer confirmation.
orders_get
ChatGPTRead one authenticated customer order.
orders_get_tracking
ChatGPTRead normalized tracking events for one authenticated customer order.
orders_list
ChatGPTList authenticated customer orders with bounded pagination.
orders_request_cancellation
ChatGPTRequest cancellation and any applicable refund only after confirming the exact current order total and currency.
support_conversation_close
ChatGPTClose one customer-owned conversation after explicit confirmation.
support_conversation_create
ChatGPTCreate a support conversation using the exact customer-approved message.
support_conversations_list
ChatGPTList authenticated customer support conversations.
support_message_send
ChatGPTSend the exact customer-approved message to one owned conversation.
support_messages_list
ChatGPTRead messages in one customer-owned support conversation.