Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
Customer Engagement & Analytics
1. List Abandoned Carts (mcp_Zid_ListAbandonedCarts)
Retrieve a list of abandoned shopping carts with detailed filtering options.
Call this tool with optional parameters to filter and analyze abandoned carts.
page (number): Page number for pagination (default: 1)pageSize (number): Number of carts per page (default: 10, max: 100)phase (string): Filter by cart phase (new, login, shipping_address, shipping_method, payment_method, verification, completed)searchTerm (string): Search by customer name, email, or cart contentproductsCount (number): Filter by number of products in cartdateFrom/dateTo (string): Filter by cart creation date range (format: YYYY-MM-DD)cartTotal (number): Filter by cart total valuelanguage (string): Response language (en or ar)2. Get Abandoned Cart Details (mcp_Zid_GetAbandonedCartDetails)
Fetch detailed information about a specific abandoned cart.
Provide the cartId to retrieve detailed cart information.
cartId (string): The unique ID of the abandoned cartlanguage (string): Response language (en or ar)3. List Product Reviews (mcp_Zid_ListProductReviews)
Retrieve a list of product reviews with filtering and sorting options.
Call this tool with optional parameters to filter and sort reviews.
page (number): Page number for pagination (default: 1)pageSize (number): Number of reviews per page (default: 10, max: 100)searchTerm (string): Search by customer name, review content, etc.status (string): Filter by review status (approved, pending, rejected, spam)dateFrom/dateTo (string): Filter by review creation date rangecustomerId (number): Filter by specific customer IDsortBy (string): Sort order (asc or desc)orderBy (string): Field to sort bylanguage (string): Response language (en or ar)4. Count Reviews by Status (mcp_Zid_CountReviewsByStatus)
Get a count of reviews filtered by their approval status.
Provide the status to get the count of reviews in that status.
status (string): Review status to count (pending, approved, rejected, spam)searchTerm (string, optional): Search term to filter reviewsdateFrom/dateTo (string, optional): Date range filtercustomerId (number, optional): Filter by customer IDlanguage (string): Response language (en or ar)5. Update Review Status (mcp_Zid_action_UpdateReviewStatus)
Change the approval status of a specific product review.
Provide the reviewId and the new status.
reviewId (string): The unique ID of the reviewstatus (string): New status (pending, approved, rejected, spam)language (string): Response language (en or ar)6. Update All Reviews Status (mcp_Zid_action_UpdateAllReviewsStatus)
Change the approval status of all reviews at once.
Provide the new status to update all reviews.
status (string): New status for all reviews (pending, approved, rejected, spam)language (string): Response language (en or ar)7. Delete Review (mcp_Zid_action_DeleteReview)
Permanently remove a product review from your store.
Provide the reviewId to delete the review.
reviewId (string): The unique ID of the review to deletelanguage (string): Response language (en or ar)8. Reply to Review (mcp_Zid_action_ReplyToReview)
Add a store response to a customer review.
Provide the reviewId and your response text.
reviewId (string): The unique ID of the reviewtext (string): Your response textlanguage (string): Response language (en or ar)9. Manage Review Replies (mcp_Zid_action_DeleteReviewReply, mcp_Zid_action_UpdateReviewReply)
Delete or update existing replies to customer reviews.
Provide the reviewId and replyId for the specific reply.
reviewId (string): The unique ID of the reviewreplyId (string): The unique ID of the replytext (string): Updated reply text (for update only)language (string): Response language (en or ar)10. Get Product Questions (mcp_Zid_GetProductQuestions)
Retrieve a list of questions asked about a specific product.
Provide the productId to get all questions for that product.
productId (string): The unique ID of the productlanguage (string): Response language (en or ar)11. Create Product Question (mcp_Zid_action_CreateProductQuestion)
Add a new customer question about a product.
Provide the product information and customer details.
productId (string): The unique ID of the productname (string): Customer nameemail (string): Customer email addressquestion (string): The question textlanguage (string): Response language (en or ar)12. Manage Questions (mcp_Zid_GetQuestion, mcp_Zid_action_UpdateQuestionPublishing, mcp_Zid_action_DeleteQuestion)
View, publish/unpublish, or delete specific product questions.
Use different tools for different question operations.
questionId (string): The unique ID of the questionisPublished (boolean): Whether to publish the questionlanguage (string): Response language (en or ar)13. Manage Question Answers (mcp_Zid_GetQuestionAnswers, mcp_Zid_action_CreateAnswer, mcp_Zid_GetAnswer, mcp_Zid_action_UpdateAnswer, mcp_Zid_action_DeleteAnswer)
Manage answers to customer questions about products.
Use different tools for different answer operations.
questionId (string): The unique ID of the questionanswerId (string): The unique ID of the answeranswer (string): Answer textlanguage (string): Response language (en or ar)14. Manage Availability Notifications (mcp_Zid_GetAvailabilityNotificationStats, mcp_Zid_GetAvailabilityNotificationSettings, mcp_Zid_action_SaveAvailabilityNotificationSettings, mcp_Zid_ListAvailabilityNotifications, mcp_Zid_action_AddAvailabilityNotification, mcp_Zid_action_SendAvailabilityNotificationEmail, mcp_Zid_action_ExportAvailabilityNotifications)
Manage customer notifications for out-of-stock products and related settings.
Use different tools for different notification operations.
delayUnit (string): Delay unit for notificationsdelayValue (number): Delay valueemailText (object): Email text {ar: "النص", en: "Text"}emailTitle (object): Email title {ar: "العنوان", en: "Title"}productId (string): The unique ID of the productemail (string): Customer emaillanguage (string): Response language (en or ar)name (string, optional): Customer namephone (string, optional): Customer phonecustomerId (string, optional): Customer IDcustomerPhoneNumber (string, optional): Customer phone numbercustomerName (string, optional): Customer namecontent (string): Email contenttitle (string): Email titlemethod (string, optional): Notification method (default: "email")isNotified (boolean, optional): Filter by notification statusSummary Table
| Tool Name | Purpose/Use Case | Key Parameters |
|---|---|---|
| List Abandoned Carts | Display and filter abandoned carts | page, pageSize, phase, searchTerm, dateFrom, dateTo, cartTotal |
| Get Abandoned Cart Details | Fetch detailed cart information | cartId |
| List Product Reviews | Display and filter product reviews | page, pageSize, status, searchTerm, dateFrom, dateTo, customerId, sortBy, orderBy |
| Count Reviews by Status | Count reviews by approval status | status, searchTerm, dateFrom, dateTo, customerId |
| Update Review Status | Change review approval status | reviewId, status |
| Update All Reviews Status | Bulk update review status | status |
| Delete Review | Remove review permanently | reviewId |
| Reply to Review | Add store response to review | reviewId, text |
| Delete/Update Review Reply | Manage review responses | reviewId, replyId, text |
| Get Product Questions | List questions for a product | productId |
| Create Product Question | Add new customer question | productId, name, email, question |
| Get/Update/Delete Question | Manage individual questions | questionId, isPublished |
| Get/Create/Update/Delete Answer | Manage question answers | questionId, answerId, answer |
| Get Notification Stats/Settings | View notification configuration | (none required) |
| Save Notification Settings | Configure notification system | delayUnit, delayValue, emailText, emailTitle |
| List/Add/Send/Export Notifications | Manage availability notifications | productId, email, various parameters |
Best Practices for Customer Engagement & Analytics
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
Modified at 2025-08-25 16:59:45