Product Vouchers & Digital Codes

This guide explains how to use the Zid MCP tools for managing product vouchers, digital codes, gift cards, and related voucher operations in your Zid store. Each tool is callable from your MCP environment and supports voucher management, inventory tracking, and digital code distribution.

1. Get Product Vouchers (mcp_Zid_GetProductVouchers)

Purpose:
Retrieve a list of vouchers associated with a specific product.

Use Cases:

Display all vouchers for a product in admin dashboard

Monitor voucher inventory and usage

Track voucher sales and performance

Manage voucher lifecycle

How to Use:
Provide the productId and voucherId to get voucher information.

Parameters:

productId (string): The unique ID of the product

voucherId (string): The unique ID of the voucher

order (string, optional): Associated order

status (string, optional): Voucher status

query (string, optional): Search query

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

Example Usage:

2. Add Product Voucher (mcp_Zid_action_AddProductVoucher)

Purpose:
Add a new voucher to a specific product.

Use Cases:

Create digital gift cards for products

Add promotional codes

Generate voucher inventory

Set up digital product codes

How to Use:
Provide the product information and voucher details.

Parameters:

productId (string): The unique ID of the product

voucherId (string): The unique ID of the 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

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

Example Usage:

3. Update Product Voucher (mcp_Zid_action_UpdateProductVoucher)

Purpose:
Modify existing voucher information or status.

Use Cases:

Update voucher status after sale

Modify voucher details

Mark vouchers as used or returned

Update voucher expiration dates

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

Parameters:

productId (string): The unique ID of the product

voucherId (string): The unique ID of the voucher

key (string, optional): Updated voucher key/code

status (string, optional): Updated voucher status (AVAILABLE, SOLD, RESERVED, RETURNED)

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

Example Usage:

4. Remove Product Voucher (mcp_Zid_action_RemoveProductVoucher)

Purpose:
Remove a voucher from a product.

Use Cases:

Remove invalid or expired vouchers

Clean up voucher inventory

Remove vouchers that are no longer valid

Manage voucher lifecycle

How to Use:
Provide the productId and voucherId to remove the voucher.

Parameters:

productId (string): The unique ID of the product

voucherId (string): The unique ID of the voucher to remove

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

Example Usage:

5. Export Product Vouchers (mcp_Zid_action_ExportProductVouchers)

Purpose:
Export voucher data for a specific product to an email address.

Use Cases:

Generate voucher reports for products

Share voucher data with team members

Backup voucher information

Analyze voucher usage and performance

How to Use:
Provide the productId and email address for the export.

Parameters:

productId (string): The unique ID of the product

email (string): Email address to receive the export

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

Example Usage:

6. Get Order Vouchers (mcp_Zid_GetOrderVouchers)

Purpose:
Retrieve a list of vouchers associated with a specific order.

Use Cases:

Display vouchers purchased in an order

Track voucher sales and usage

Manage order-related vouchers

Verify voucher delivery

How to Use:
Provide the orderId to get all vouchers for that order.

Parameters:

orderId (string): The unique ID of the order

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

pageSize (number): Number per page (default: 15, max: 100)

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

Example Usage:

Summary Table

Tool Name	Purpose/Use Case	Key Parameters
Get Product Vouchers	List vouchers for a product	productId, voucherId, order, status, query
Add Product Voucher	Add new voucher to product	productId, voucherId, key, status, serialNumber, pinCode, order, expiresAt
Update Product Voucher	Modify voucher information	productId, voucherId, key, status
Remove Product Voucher	Remove voucher from product	productId, voucherId
Export Product Vouchers	Export voucher data	productId, email
Get Order Vouchers	List vouchers for an order	orderId, page, pageSize

Best Practices for Product Vouchers & Digital Codes

Voucher Security: Use secure, unique voucher keys and PIN codes

Status Management: Maintain accurate voucher status throughout their lifecycle

Inventory Tracking: Keep track of available, sold, and returned vouchers

Expiration Management: Set appropriate expiration dates for vouchers

Order Association: Properly link vouchers to orders when sold

Data Export: Regularly export voucher data for analysis and backup

Validation: Implement proper validation for voucher codes and status

Audit Trail: Maintain records of voucher status changes

Customer Support: Provide clear information about voucher usage

10.

Performance Monitoring: Monitor voucher sales and usage patterns

Voucher Management Workflow Examples

Creating Voucher Inventory

Voucher Sales Process

Voucher Return Process

Voucher Reporting

This comprehensive product vouchers and digital codes system allows you to efficiently manage digital gift cards, promotional codes, and other voucher types while maintaining secure inventory tracking and providing detailed reporting capabilities.

Product Vouchers & Digital Codes

1. Get Product Vouchers (mcp_Zid_GetProductVouchers)#

2. Add Product Voucher (mcp_Zid_action_AddProductVoucher)#

3. Update Product Voucher (mcp_Zid_action_UpdateProductVoucher)#

4. Remove Product Voucher (mcp_Zid_action_RemoveProductVoucher)#

5. Export Product Vouchers (mcp_Zid_action_ExportProductVouchers)#

6. Get Order Vouchers (mcp_Zid_GetOrderVouchers)#

Summary Table#

Best Practices for Product Vouchers & Digital Codes#

Voucher Management Workflow Examples#

Creating Voucher Inventory#

Voucher Sales Process#

Voucher Return Process#

Voucher Reporting#

1. Get Product Vouchers (mcp_Zid_GetProductVouchers)

2. Add Product Voucher (mcp_Zid_action_AddProductVoucher)

3. Update Product Voucher (mcp_Zid_action_UpdateProductVoucher)

4. Remove Product Voucher (mcp_Zid_action_RemoveProductVoucher)

5. Export Product Vouchers (mcp_Zid_action_ExportProductVouchers)

6. Get Order Vouchers (mcp_Zid_GetOrderVouchers)

Summary Table

Best Practices for Product Vouchers & Digital Codes

Voucher Management Workflow Examples

Creating Voucher Inventory

Voucher Sales Process

Voucher Return Process

Voucher Reporting