Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.
language
(string): Response language (en or ar)
locationId
(string): The unique ID of the store locationlanguage
(string): Response language (en or ar)
name
(object): Location name in both languages {ar: "اسم الموقع", en: "Location Name"}coordinates
(object): GPS coordinates {longitude: number, latitude: number}fullAddress
(string): Complete address of the locationcity
(number): City ID for the locationisDefault
(boolean): Whether this is the default locationisPrivate
(boolean): Whether this location is privateisEnabled
(boolean): Whether this location is enabledlanguage
(string): Response language (en or ar)
locationId
(string): The unique ID of the store locationname
(string, optional): Updated location namedescription
(string, optional): Updated location descriptionisActive
(boolean, optional): Updated active statuslanguage
(string): Response language (en or ar)
locationId
(string): The unique ID of the store locationproducts
(array): Array of product objects with:productId
(string): The unique ID of the productavailableQuantity
(number): Available quantity (minimum: 0)isInfinite
(boolean): Whether stock is infinite (default: false)language
(string): Response language (en or ar)
productId
(string): The unique ID of the productlanguage
(string): Response language (en or ar)
productId
(string): The unique ID of the productstockId
(string): The unique ID of the stock entrylanguage
(string): Response language (en or ar)
productId
(string): The unique ID of the productstockId
(string): The unique ID of the stock entryavailableQuantity
(number or null): Available quantity (null for infinite)isInfinite
(boolean): Whether stock is infinitelanguage
(string): Response language (en or ar)
productId
(string): The unique ID of the productlocation
(string): Location name for the stockavailableQuantity
(number): Available quantityisInfinite
(boolean): Whether stock is infinitelanguage
(string): Response language (en or ar)
productId
(string): The unique ID of the productstocks
(array): Array of stock objects with:location
(string): Location nameavailableQuantity
(number or null): Available quantity (null for infinite)isInfinite
(boolean): Whether stock is infinitelanguage
(string): Response language (en or ar)
language
(string): Response language (en or ar)
name
(string): Shipping option namecost
(string): Shipping costcodEnabled
(string): Whether Cash on Delivery is enabledcodFee
(string): Cash on Delivery feecities
(array): Array of city IDs where this option is availabledeliveryEstimatedTimeAr
(string): Estimated delivery time in ArabicdeliveryEstimatedTimeEn
(string): Estimated delivery time in Englishlanguage
(string): Response language (en or ar)
Tool Name | Purpose/Use Case | Key Parameters |
---|---|---|
List Store Locations | Display all store locations | (none required) |
Get Store Location | Fetch details for specific location | locationId |
Add Store Location | Create new store location | name, coordinates, fullAddress, city, isDefault, isPrivate, isEnabled |
Update Store Location | Modify existing location | locationId, name, description, isActive |
Update Location Stock | Update stock for multiple products at location | locationId, products array |
List Product Stocks | List all stock entries for a product | productId |
Get Product Stock | Fetch details for specific stock entry | productId, stockId |
Update Product Stock | Update stock for specific product | productId, stockId, availableQuantity, isInfinite |
Add Product Stock | Add new stock entry for product | productId, location, availableQuantity, isInfinite |
Bulk Update Product Stocks | Update stock for multiple products | productId, stocks array |
List Delivery Options | List all delivery options | (none required) |
Add Shipping Option | Create new shipping option | name, cost, codEnabled, codFee, cities, deliveryEstimatedTimeAr, deliveryEstimatedTimeEn |