> ## Documentation Index > Fetch the complete documentation index at: https://twigz.arqqin.com/llms.txt > Use this file to discover all available pages before exploring further. # Store Onboarding > Administrative store creation, product management, and onboarding operations ## Overview Store Onboarding API provides administrative functions for creating and managing stores, products, store categories, and delivery zones on behalf of store owners. These are admin-only mutations used during the onboarding flow or for ongoing store management. **Location:** `convex/admins/storeOnboarding.ts` *** ## Admin Create Store Creates a new store with optional auto-approval. When auto-approved, the store is immediately set to active and a wallet is initialized. Increments the `storeCount` on the assigned primary category. Store name Store name in Arabic Store description Primary category ID for the store Owner's Clerk user ID. Defaults to `"admin_managed"` if not provided. Store owner's full name Store owner's phone number Store contact email Storage ID for the store logo image Storage ID for the store cover/banner image Storage ID for the trade license document If true, store is created with `approved` status, `isActive: true`, and a wallet is initialized automatically Store settings: * `deliveryEnabled` — Whether delivery is enabled * `pickupEnabled` — Whether pickup is enabled * `allowsReturns` — Whether returns are accepted * `returnWindowDays` — Return window in days Bank account details: * `IBAN` — Bank IBAN number * `bankName` — Bank name * `bankId` — Bank ID reference * `accountHolderName` — Account holder name Store address: * `fullAddress` — Full address string * `city` — City ID * `area` — Area ID * `flatVilaNumber` — Flat/villa number * `buildingNameNumber` — Building name or number * `landmark` — Nearby landmark * `latitude` — Latitude coordinate * `longitude` — Longitude coordinate ```typescript TypeScript theme={null} const storeId = await convex.mutation(api.admins.storeOnboarding.adminCreateStore, { name: "Pizza Palace", nameArabic: "قصر البيتزا", description: "Best pizza in town", primaryCategory: "cat_food", ownerName: "Ahmed Ali", phoneNumber: "+971501234567", email: "ahmed@pizzapalace.ae", autoApprove: true, settings: { deliveryEnabled: true, pickupEnabled: true, allowsReturns: false }, bankAccount: { IBAN: "AE070331234567890123456", bankName: "Emirates NBD", accountHolderName: "Ahmed Ali" }, address: { fullAddress: "Building 5, Downtown Dubai", city: "city_dubai", area: "area_downtown" } }); ``` ```json Response theme={null} "s123456789" ``` *** ## Admin Update Store Updates an existing store's fields. Only provided fields are updated. If `primaryCategory` changes, the denormalized `storeCount` on both old and new categories is updated. Store ID to update Updated store name Updated store name in Arabic Updated description Updated primary category (triggers counter updates) Updated owner user ID Updated owner name Updated phone number Updated email Updated logo storage ID Updated cover image storage ID Updated trade license storage ID Updated store settings (same structure as create) Updated bank account details (same structure as create) Updated store address (same structure as create) ```typescript TypeScript theme={null} const storeId = await convex.mutation(api.admins.storeOnboarding.adminUpdateStore, { storeId: "s123456789", name: "Pizza Palace Premium", description: "Premium pizza experience", settings: { deliveryEnabled: true, pickupEnabled: true, allowsReturns: true, returnWindowDays: 7 } }); ``` *** ## Admin Create Product Creates a product for a store. Validates that the product category is a child of the store's primary category. Store ID to add the product to Product name Product description Product category ID (must be a child of the store's primary category) Product price in AED Product cost (for profit tracking) Available stock quantity Low stock alert threshold Preparation time value Preparation time unit: `minutes`, `hours`, or `days` Whether the product is active and visible Storage ID for the primary product image Additional product image storage IDs Whether the product can be returned Whether delivery is available for this product Whether pickup is available for this product ```typescript TypeScript theme={null} const productId = await convex.mutation(api.admins.storeOnboarding.adminCreateProduct, { storeId: "s123456789", name: "Margherita Pizza", description: "Classic margherita with fresh mozzarella", category: "cat_pizza", price: 45.00, cost: 15.00, stock: 100, stockAlert: 10, prepTime: 20, prepTimeUnit: "minutes", isActive: true, primaryImage: "img_storage_id", isDeliveryEnabled: true, isPickupEnabled: true }); ``` *** ## Admin Update Product Updates an existing product. Only provided fields are modified. Product ID to update Updated product name Updated description Updated category Updated price Updated cost Updated stock quantity Updated stock alert threshold Updated preparation time Updated preparation time unit: `minutes`, `hours`, or `days` Updated active status Updated primary image storage ID Updated additional images Updated returnable flag Updated delivery flag Updated pickup flag ```typescript TypeScript theme={null} const productId = await convex.mutation(api.admins.storeOnboarding.adminUpdateProduct, { productId: "prod_123456789", price: 50.00, stock: 200, isActive: true }); ``` *** ## Admin Delete Product Permanently deletes a product from the database. Product ID to delete ```typescript TypeScript theme={null} const result = await convex.mutation(api.admins.storeOnboarding.adminDeleteProduct, { productId: "prod_123456789" }); // result: { success: true } ``` *** ## Admin Create Store Category Creates a store-level category under the store's primary category. Store categories are used to organize products within a store. Store ID to create the category for Category name in English Category name in Arabic Whether the category is active (default: true) ```typescript TypeScript theme={null} const categoryId = await convex.mutation(api.admins.storeOnboarding.adminCreateStoreCategory, { storeId: "s123456789", name: "Pizzas", nameArabic: "بيتزا", isActive: true }); ``` *** ## Admin Update Store Category Updates a store-level category. Cannot update global (platform-level) categories. Category ID to update Updated category name Updated Arabic category name Updated active status ```typescript TypeScript theme={null} const categoryId = await convex.mutation(api.admins.storeOnboarding.adminUpdateStoreCategory, { categoryId: "cat_123456789", name: "Specialty Pizzas", nameArabic: "بيتزا مميزة" }); ``` This mutation only works on store-level categories (those with a `storeId` field). Attempting to update a global category will throw an error. *** ## Admin Delete Store Category Permanently deletes a store-level category. Cannot delete global categories. Category ID to delete ```typescript TypeScript theme={null} const result = await convex.mutation(api.admins.storeOnboarding.adminDeleteStoreCategory, { categoryId: "cat_123456789" }); // result: { success: true } ``` This mutation only works on store-level categories. Products assigned to this category will retain their category reference, but the category will no longer exist. *** ## Admin Create Delivery Zone Creates or updates a delivery zone for a store. If a zone already exists for the same store and city combination, it is updated (upsert behavior). Store ID to create the delivery zone for City ID for the delivery zone Array of area configurations, each containing: * `area` (Id\<'areas'>, required) — Area ID * `deliveryFee` (number) — Delivery fee for this area in AED * `deliveryTime` (number) — Estimated delivery time * `deliveryTimeUnit` (string) — Time unit: `minutes`, `hours`, or `days` Default delivery fee for the zone in AED Default delivery time for the zone Default delivery time unit: `minutes`, `hours`, or `days` ```typescript TypeScript theme={null} const result = await convex.mutation(api.admins.storeOnboarding.adminCreateDeliveryZone, { storeId: "s123456789", city: "city_dubai", areas: [ { area: "area_downtown", deliveryFee: 10, deliveryTime: 30, deliveryTimeUnit: "minutes" }, { area: "area_marina", deliveryFee: 15, deliveryTime: 45, deliveryTimeUnit: "minutes" } ], deliveryFee: 12, deliveryTime: 35, deliveryTimeUnit: "minutes" }); // result: { id: "dz123456789", action: "created" } ``` ```json Response theme={null} { "id": "dz123456789", "action": "created" } ``` If a delivery zone for the same store + city combination already exists, the zone is updated instead of creating a duplicate. The response `action` field indicates whether the zone was `"created"` or `"updated"`. *** ## Admin Delete Delivery Zone Permanently deletes a delivery zone. Delivery zone ID to delete ```typescript TypeScript theme={null} const result = await convex.mutation(api.admins.storeOnboarding.adminDeleteDeliveryZone, { zoneId: "dz123456789" }); // result: { success: true } ```