Orders

This guide explains how to use the Zid MCP tools for managing orders, returns, 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. `mcp_Zid_ListOrders` – List Orders

Purpose:
Retrieve a paginated list of orders from your Zid store, with advanced filtering options.

Use Cases:

Display recent orders in your admin dashboard.

Filter by status (e.g., "new", "delivered").

Search by customer, date, or payment method.

Parameters:

Name	Type	Description
`page`	number	Pagination page (default: 1)
`perPage`	number	Items per page (default: 10, max: 100)
`orderStatus`	string	Filter (`new`, `preparing`, `ready`, etc.)
`paymentMethod`	string	Payment type (`zid_cod`, `zid_credit_card`, etc.)
`customerId`	number	Filter by customer ID
`dateFrom` / `dateTo`	string	Date range (`YYYY-MM-DD`)
`sortBy`	string	Sort direction (`asc`, `desc`)
`searchTerm`	string	Search by name/order number
`language`	string	`en` or `ar`

Examples:

2. `mcp_Zid_GetOrderDetails` – Get Order Details

Purpose:
Fetch complete details of a specific order including items, customer info, shipping, and payment.

Parameters:

Name	Type	Description
`orderId`	number or string	The order’s unique ID
`language`	string	`en` or `ar`

Example:

3. `mcp_Zid_action_UpdateOrderStatus` – Update Order Status

Purpose:
Change the status of an order (e.g., mark as "preparing", "delivered").

Parameters:

Name	Type	Description
`orderId`	number or string	Target order ID
`orderStatus`	string	New status
`inventoryAddressId`	string (optional)	Inventory location
`trackingNumber`	string (optional)	Shipment tracking code
`trackingUrl`	string (optional)	Shipment tracking link
`waybillUrl`	string (optional)	Waybill document URL
`language`	string	`en` or `ar`

Examples:

4. `mcp_Zid_GetOrderCreditNotes` – Get Credit Notes

Purpose:
List all credit notes (refunds, adjustments) for a specific order.

Parameters:

Name	Type	Description
`orderId`	number or string	Order ID
`language`	string	`en` or `ar`

Example:

5. `mcp_Zid_GetOrderVouchers` – Get Order Vouchers

Purpose:
List all vouchers (gift cards, codes) tied to a specific order.

Parameters:

Name	Type	Description
`orderId`	string	Order ID
`page`	number	Page number (default: 1)
`pageSize`	number	Items per page (default: 15, max: 100)
`language`	string	`en` or `ar`

Example:

6. `mcp_Zid_GetReverseOrderReasons` – Get Return Reasons

Purpose:
Retrieve available reasons for reverse orders (returns/refunds).

Parameters:

Name	Type	Description
`language`	string	`en` or `ar` (optional)

Example:

7. `mcp_Zid_action_AddReverseOrderReason` – Add Return Reason

Purpose:
Add a custom reason to the list of return/refund reasons.

Parameters:

Name	Type	Description
`name`	string	Reason text
`language`	string	`en` or `ar`

Example:

8. `mcp_Zid_action_CreateReverseOrder` – Create Reverse Order

Purpose:
Initiate a reverse order (return/refund) for an existing order.

Parameters:

Name	Type	Description
`orderId`	number	Original order ID
`consigneeName`	string	Return recipient name
`consigneeMobile`	string	Recipient mobile
`consigneeCityId`	number	City ID
`consigneeAddress1`	string	Address line 1
`consigneeAddress2`	string (optional)	Address line 2
`inventoryLocationId`	string (optional)	Inventory location
`reason`	string[]	Reason(s)
`language`	string	`en` or `ar`

Example:

9. `mcp_Zid_action_CreateReverseOrderWaybill` – Generate Return Waybill

Purpose:
Create a return shipping waybill for the reverse order.

Parameters:

Name	Type	Description
`orderId`	number	Original order ID
`isStandaloneZidshipWaybill`	boolean (optional)	Defaults to `true`
`language`	string	`en` or `ar`

Example:

Summary Table

Tool	Purpose	Key Params
`ListOrders`	List/filter orders	`orderStatus`, `dateFrom`, `searchTerm`
`GetOrderDetails`	View full order info	`orderId`
`UpdateOrderStatus`	Change order state	`orderId`, `orderStatus`
`GetOrderCreditNotes`	View refunds	`orderId`
`GetOrderVouchers`	View gift cards/codes	`orderId`, `page`
`GetReverseOrderReasons`	Show return reasons	(optional) `language`
`AddReverseOrderReason`	Add a return reason	`name`
`CreateReverseOrder`	Submit a return	`orderId`, `reason`, consignee info
`CreateReverseOrderWaybill`	Generate return label	`orderId`

1. mcp_Zid_ListOrders – List Orders#

2. mcp_Zid_GetOrderDetails – Get Order Details#

3. mcp_Zid_action_UpdateOrderStatus – Update Order Status#

4. mcp_Zid_GetOrderCreditNotes – Get Credit Notes#

5. mcp_Zid_GetOrderVouchers – Get Order Vouchers#

6. mcp_Zid_GetReverseOrderReasons – Get Return Reasons#

7. mcp_Zid_action_AddReverseOrderReason – Add Return Reason#

8. mcp_Zid_action_CreateReverseOrder – Create Reverse Order#

9. mcp_Zid_action_CreateReverseOrderWaybill – Generate Return Waybill#

Summary Table#

1. `mcp_Zid_ListOrders` – List Orders

2. `mcp_Zid_GetOrderDetails` – Get Order Details

3. `mcp_Zid_action_UpdateOrderStatus` – Update Order Status

4. `mcp_Zid_GetOrderCreditNotes` – Get Credit Notes

5. `mcp_Zid_GetOrderVouchers` – Get Order Vouchers

6. `mcp_Zid_GetReverseOrderReasons` – Get Return Reasons

7. `mcp_Zid_action_AddReverseOrderReason` – Add Return Reason

8. `mcp_Zid_action_CreateReverseOrder` – Create Reverse Order

9. `mcp_Zid_action_CreateReverseOrderWaybill` – Generate Return Waybill

Summary Table