Products Management

This guide explains how to use the Zid MCP tools for managing products, inventory, and related data in your Zid store. Each tool is callable from your MCP environment and supports flexible filtering, localization, and integration into dashboards or workflows.

1. List Products (mcp_Zid_ListProducts)

Purpose:
Retrieve a paginated list of products from your Zid store, with filtering and search capabilities.

Use Cases:

Display all products in your admin dashboard

Filter products by attributes or search terms

Export product catalogs for analysis

How to Use:
Call this tool with optional parameters to filter and paginate the results.

Parameters:

page (number): Page number for pagination (default: 1)

pageSize (number): Number of products per page (default: 10, max: 50)

attributeValues (string): Filter by attribute values

language (string): Response language (en or ar)

Example Usage:

2. Get Product Details (mcp_Zid_GetProductDetails)

Purpose:
Fetch detailed information about a specific product, including variants, images, and specifications.

Use Cases:

View complete product information in admin panel

Display product details to customer support agents

Analyze product performance and inventory

How to Use:
Provide the productId to retrieve the product details.

Parameters:

productId (string): The unique ID of the product

language (string): Response language (en or ar)

Example Usage:

3. Create Product (mcp_Zid_action_CreateProduct)

Purpose:
Create a new product in your Zid store with basic information and settings.

Use Cases:

Add new products to your catalog

Bulk import products from external systems

Create product templates for similar items

How to Use:
Provide the required product information including name, SKU, and price.

Parameters:

name (object): Product name in Arabic and English {ar: "اسم المنتج", en: "Product Name"}

sku (string): Stock Keeping Unit (unique identifier)

price (number): Product price

isPublished (boolean, optional): Whether product is published (default: true)

isTaxable (boolean, optional): Whether product is taxable (default: true)

requiresShipping (boolean, optional): Whether product requires shipping (default: true)

description (object, optional): Product description {ar: "وصف", en: "Description"}

shortDescription (object, optional): Short description {ar: "وصف قصير", en: "Short Description"}

weight (object, optional): Product weight {value: number, unit: "kg"}

salePrice (number, optional): Sale price for discounts

language (string): Response language (en or ar)

Example Usage:

4. Update Product (mcp_Zid_action_UpdateProduct)

Purpose:
Modify existing product information, pricing, or settings.

Use Cases:

Update product prices or descriptions

Change product status (published/unpublished)

Modify product specifications

How to Use:
Provide the productId and the fields you want to update.

Parameters:

productId (string): The unique ID of the product

name (object, optional): Updated product name {ar: "اسم", en: "Name"}

price (number, optional): Updated price

isPublished (boolean, optional): Updated publish status

isTaxable (boolean, optional): Updated tax status

description (object, optional): Updated description {ar: "وصف", en: "Description"}

shortDescription (object, optional): Updated short description {ar: "وصف قصير", en: "Short Description"}

weight (object, optional): Updated weight {value: number, unit: "kg"}

salePrice (number, optional): Updated sale price

language (string): Response language (en or ar)

Example Usage:

5. Delete Product (mcp_Zid_action_DeleteProduct)

Purpose:
Remove a product from your Zid store permanently.

Use Cases:

Remove discontinued products

Clean up test products

Manage inventory by removing obsolete items

How to Use:
Provide the productId to delete the product.

Parameters:

productId (string): The unique ID of the product to delete

language (string): Response language (en or ar)

Example Usage:

6. Get Product Settings (mcp_Zid_GetProductSettings)

Purpose:
Retrieve global product settings and configurations for your store.

Use Cases:

View store-wide product settings

Configure product display options

Set up product management preferences

How to Use:
No parameters required, just specify the language.

Parameters:

language (string): Response language (en or ar)

Example Usage:

7. Manage Product Images (mcp_Zid_GetProductImages, mcp_Zid_action_AddProductImage, mcp_Zid_action_UpdateProductImageSorting, mcp_Zid_action_DeleteProductImage)

Purpose:
Manage product images including adding, sorting, and removing images.

Use Cases:

Add product photos to enhance listings

Organize product images in specific order

Remove outdated or inappropriate images

How to Use:
Use different tools for different image operations.

Parameters:

productId (string): The unique ID of the product

imageUrl (string): URL of the image to add

altText (string): Alternative text for the image

imageId (string/number): ID of the specific image

displayOrder (number): Order for displaying images

language (string): Response language (en or ar)

Example Usage:

8. Manage Product Stock (mcp_Zid_ListProductStocks, mcp_Zid_GetProductStock, mcp_Zid_action_UpdateProductStock, mcp_Zid_action_AddProductStock, mcp_Zid_action_BulkUpdateProductStocks)

Purpose:
Manage product inventory across different locations and track stock levels.

Use Cases:

Monitor inventory levels across multiple locations

Update stock quantities when receiving shipments

Set up infinite stock for digital products

Bulk update stock for multiple products

How to Use:
Use different tools for different stock operations.

Parameters:

productId (string): The unique ID of the product

stockId (string): ID of the specific stock entry

location (string): Location name for the stock

availableQuantity (number): Available quantity (null for infinite)

isInfinite (boolean): Whether stock is infinite

stocks (array): Array of stock objects for bulk operations

language (string): Response language (en or ar)

Example Usage:

9. Manage Product Variants (mcp_Zid_action_AddProductVariants)

Purpose:
Add product variants with different attributes like size, color, or material.

Use Cases:

Create products with multiple options (e.g., shirts in different sizes and colors)

Set different prices for different variants

Manage inventory for each variant separately

How to Use:
Provide the productId and an array of variant objects.

Parameters:

productId (string): The unique ID of the product

variants (array): Array of variant objects with:

sku (string): Variant SKU

price (number): Variant price

quantity (number): Available quantity

is_infinite (boolean): Whether stock is infinite

attributes (array): Array of attribute objects {slug: "color", value: {ar: "أحمر", en: "Red"}}

images (array, optional): Array of image URLs

weight (object, optional): Variant weight {value: number, unit: "kg"}

language (string): Response language (en or ar)

Example Usage:

10. Manage Product Custom Options (mcp_Zid_action_AddProductCustomOptions, mcp_Zid_action_AddProductCustomInputField)

Purpose:
Add custom options or input fields to products for personalization.

Use Cases:

Add engraving options to jewelry

Allow customers to specify custom text

Create dropdown options for product customization

How to Use:
Use different tools for custom options vs input fields.

Parameters:

productId (string): The unique ID of the product

label (object): Option label {ar: "التسمية", en: "Label"}

choices (array): Array of choice objects {ar: "الخيار", en: "Choice", price: "10"}

hint (object, optional): Hint text {ar: "تلميح", en: "Hint"}

type (string): Input field type (text, number, dropdown)

price (string): Additional price for the option

language (string): Response language (en or ar)

Example Usage:

11. Manage Product Vouchers (mcp_Zid_GetProductVouchers, mcp_Zid_action_AddProductVoucher, mcp_Zid_action_UpdateProductVoucher, mcp_Zid_action_RemoveProductVoucher, mcp_Zid_action_ExportProductVouchers)

Purpose:
Manage digital vouchers, gift cards, or codes associated with products.

Use Cases:

Sell digital gift cards

Manage promotional codes

Track voucher inventory and usage

How to Use:
Use different tools for different voucher operations.

Parameters:

productId (string): The unique ID of the product

voucherId (string): ID of the specific voucher

key (string): Voucher key/code

status (string): Voucher status (AVAILABLE, SOLD, RESERVED, RETURNED)

serialNumber (string, optional): Serial number

pinCode (string, optional): PIN code

order (string, optional): Associated order

expiresAt (string, optional): Expiration date

email (string): Email for export

language (string): Response language (en or ar)

Example Usage:

12. Manage Product Questions & Reviews (mcp_Zid_GetProductQuestions, mcp_Zid_action_CreateProductQuestion, mcp_Zid_GetQuestion, mcp_Zid_action_UpdateQuestionPublishing, mcp_Zid_action_DeleteQuestion, mcp_Zid_GetQuestionAnswers, mcp_Zid_action_CreateAnswer, mcp_Zid_GetAnswer, mcp_Zid_action_UpdateAnswer, mcp_Zid_action_DeleteAnswer, mcp_Zid_ListProductReviews, mcp_Zid_CountReviewsByStatus, mcp_Zid_action_UpdateReviewStatus, mcp_Zid_action_UpdateAllReviewsStatus, mcp_Zid_action_DeleteReview, mcp_Zid_action_ReplyToReview, mcp_Zid_action_DeleteReviewReply, mcp_Zid_action_UpdateReviewReply)

Purpose:
Manage customer questions, answers, and product reviews.

Use Cases:

Moderate customer questions and answers

Manage product reviews and ratings

Respond to customer feedback

Control which content is published

How to Use:
Use different tools for questions vs reviews management.

Parameters:

productId (string): The unique ID of the product

questionId (string): ID of the specific question

answerId (string): ID of the specific answer

reviewId (string): ID of the specific review

replyId (string): ID of the specific reply

name (string): Customer name

email (string): Customer email

question (string): Question text

answer (string): Answer text

isPublished (boolean): Whether to publish the content

status (string): Review status (pending, approved, rejected, spam)

text (string): Reply text

language (string): Response language (en or ar)

Example Usage:

13. Manage Digital Products (mcp_Zid_action_CreateDownloadableProduct, mcp_Zid_action_GenerateUploadUrl, mcp_Zid_action_CreateProductDownloadable, mcp_Zid_GetProductDownloadables, mcp_Zid_action_DeleteProductDownloadable, mcp_Zid_GetStoreDownloadables, mcp_Zid_action_CreateStoreDownloadable, mcp_Zid_action_DeleteStoreDownloadable)

Purpose:
Manage digital products, downloadable files, and digital content.

Use Cases:

Sell digital products like e-books, software, or music

Manage downloadable files for digital products

Organize digital content in your store library

How to Use:
Use different tools for different digital product operations.

Parameters:

nameAr (string): Product name in Arabic

nameEn (string): Product name in English

price (number): Product price

isDraft (boolean, optional): Whether product is draft (default: true)

productId (string): The unique ID of the product

file (string): Storage key/path of the uploaded file

displayName (string): Name of the file as it appears to users

saveToLibrary (boolean, optional): Whether to save to library (default: true)

downloadableId (string): ID of the specific downloadable

language (string): Response language (en or ar)

Example Usage:

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)

Purpose:
Manage customer notifications for out-of-stock products.

Use Cases:

Allow customers to sign up for stock notifications

Automatically notify customers when products are back in stock

Track notification statistics and settings

How to Use:
Use different tools for different notification operations.

Parameters:

delayUnit (string): Delay unit for notifications

delayValue (number): Delay value

emailText (object): Email text {ar: "النص", en: "Text"}

emailTitle (object): Email title {ar: "العنوان", en: "Title"}

productId (string): The unique ID of the product

email (string): Customer email

language (string): Response language (en or ar)

name (string, optional): Customer name

phone (string, optional): Customer phone

customerId (string, optional): Customer ID

customerPhoneNumber (string, optional): Customer phone number

customerName (string, optional): Customer name

content (string): Email content

title (string): Email title

method (string, optional): Notification method (default: "email")

isNotified (boolean, optional): Filter by notification status

Example Usage:

15. Bulk Operations (mcp_Zid_action_BulkUpdateProducts, mcp_Zid_action_SetManualProductsSorting, mcp_Zid_action_ResetManualProductsSorting)

Purpose:
Perform bulk operations on multiple products simultaneously.

Use Cases:

Update multiple products at once

Set custom sorting order for products

Reset product sorting to default

How to Use:
Use different tools for different bulk operations.

Parameters:

products (array): Array of product objects for bulk update

category (number, optional): Category ID for sorting

language (string): Response language (en or ar)

Example Usage:

16. Export Functions (mcp_Zid_action_ExportProductsToStoreOwnerEmail)

Purpose:
Export product data to store owner's email.

Use Cases:

Generate product reports

Backup product data

Share product information with team members

How to Use:
No parameters required, just specify the language.

Parameters:

language (string): Response language (en or ar)

Example Usage:

Summary Table

Tool Name	Purpose/Use Case	Key Parameters
List Products	List/filter/search products	page, pageSize, attributeValues
Get Product Details	Fetch full details for a specific product	productId
Create Product	Add new product to catalog	name, sku, price, description
Update Product	Modify existing product information	productId, fields to update
Delete Product	Remove product from store	productId
Get Product Settings	View store-wide product settings	(none required)
Manage Product Images	Add/sort/delete product images	productId, imageUrl, imageId
Manage Product Stock	Track inventory across locations	productId, location, quantity
Manage Product Variants	Add product variants with attributes	productId, variants array
Manage Custom Options	Add customization options	productId, label, choices
Manage Product Vouchers	Handle digital vouchers/gift cards	productId, voucherId, key, status
Manage Questions & Reviews	Moderate customer content	productId, questionId, reviewId
Manage Digital Products	Handle downloadable products	productId, file, displayName
Manage Availability Notifications	Handle stock notifications	productId, email, settings
Bulk Operations	Update multiple products at once	products array
Export Functions	Export product data	(none required)

Products Management

1. List Products (mcp_Zid_ListProducts)#

2. Get Product Details (mcp_Zid_GetProductDetails)#

3. Create Product (mcp_Zid_action_CreateProduct)#

4. Update Product (mcp_Zid_action_UpdateProduct)#

5. Delete Product (mcp_Zid_action_DeleteProduct)#

6. Get Product Settings (mcp_Zid_GetProductSettings)#

7. Manage Product Images (mcp_Zid_GetProductImages, mcp_Zid_action_AddProductImage, mcp_Zid_action_UpdateProductImageSorting, mcp_Zid_action_DeleteProductImage)#

8. Manage Product Stock (mcp_Zid_ListProductStocks, mcp_Zid_GetProductStock, mcp_Zid_action_UpdateProductStock, mcp_Zid_action_AddProductStock, mcp_Zid_action_BulkUpdateProductStocks)#

9. Manage Product Variants (mcp_Zid_action_AddProductVariants)#

10. Manage Product Custom Options (mcp_Zid_action_AddProductCustomOptions, mcp_Zid_action_AddProductCustomInputField)#

11. Manage Product Vouchers (mcp_Zid_GetProductVouchers, mcp_Zid_action_AddProductVoucher, mcp_Zid_action_UpdateProductVoucher, mcp_Zid_action_RemoveProductVoucher, mcp_Zid_action_ExportProductVouchers)#

15. Bulk Operations (mcp_Zid_action_BulkUpdateProducts, mcp_Zid_action_SetManualProductsSorting, mcp_Zid_action_ResetManualProductsSorting)#

16. Export Functions (mcp_Zid_action_ExportProductsToStoreOwnerEmail)#

Summary Table#

1. List Products (mcp_Zid_ListProducts)

2. Get Product Details (mcp_Zid_GetProductDetails)

3. Create Product (mcp_Zid_action_CreateProduct)

4. Update Product (mcp_Zid_action_UpdateProduct)

5. Delete Product (mcp_Zid_action_DeleteProduct)

6. Get Product Settings (mcp_Zid_GetProductSettings)

7. Manage Product Images (mcp_Zid_GetProductImages, mcp_Zid_action_AddProductImage, mcp_Zid_action_UpdateProductImageSorting, mcp_Zid_action_DeleteProductImage)

8. Manage Product Stock (mcp_Zid_ListProductStocks, mcp_Zid_GetProductStock, mcp_Zid_action_UpdateProductStock, mcp_Zid_action_AddProductStock, mcp_Zid_action_BulkUpdateProductStocks)

9. Manage Product Variants (mcp_Zid_action_AddProductVariants)

10. Manage Product Custom Options (mcp_Zid_action_AddProductCustomOptions, mcp_Zid_action_AddProductCustomInputField)

11. Manage Product Vouchers (mcp_Zid_GetProductVouchers, mcp_Zid_action_AddProductVoucher, mcp_Zid_action_UpdateProductVoucher, mcp_Zid_action_RemoveProductVoucher, mcp_Zid_action_ExportProductVouchers)

15. Bulk Operations (mcp_Zid_action_BulkUpdateProducts, mcp_Zid_action_SetManualProductsSorting, mcp_Zid_action_ResetManualProductsSorting)

16. Export Functions (mcp_Zid_action_ExportProductsToStoreOwnerEmail)

Summary Table