Storefront Endpoints (v1)

This section documents all storefront management endpoints within workspaces.

Store Management

• Get Store - Get storefront store configuration (includes inventoryUnits for inventory unit list)
• Create Store - Create storefront store
• Update Store - Update store configuration (supports inventoryUnits for custom units)
• Upload Store Logo - Upload store logo
• Delete Store Logo - Remove store logo
• Upload Store SEO OG Image - Upload SEO Open Graph image
• Delete Store SEO OG Image - Remove SEO Open Graph image
• Patch Facebook / Meta catalog settings - Feed token (hashed), brand override, Pixel id (store.manage)
• Regenerate Meta catalog feed token - Rotate feed secret; optional absolute feedUrl in response

Categories

• List Categories - Get all categories
• Create Category - Create a new category
• Update Category - Update a category
• Upload Category Image - Upload category image
• Reorder Categories - Reorder categories within a parent

Products - Inventory

• Product cost price (workspace) - Optional costPrice on create/update for POS COGS
• Add Product Stock Movement - Add manual stock to a product (optional source: goods-receipt for ادخال بضاعة)
• List Goods Receipt Stock Movements - Paginated log of all «ادخال بضاعة» movements for the store
• List Product Stock Movements - View product stock history
• List Low Stock Products - Products below their alert threshold (responses include stockUnitId, stockUnitName)

Products - Marketing

• Generate Product Marketing Post - Generate AI marketing posts for a product

Products - Reviews

• List Product Reviews - Moderation list (store.products.manage)
• Update Product Review Status - Publish, hide, or set pending
• Delete Product Review - Permanent removal

Content pages

• Upload customer review media - Image or video for customer-reviews pages (store.manage); pair with PATCH to set customerReviewGallery

Product Options

Store-level options (modifiers) that can be linked to products (e.g. size, add-ons). When an option is disabled (isAvailable: false), it is shown as unavailable to customers in the storefront.

• List Product Options - List all store product options
• Create Product Option - Create a new product option
• Update Product Option - Update a product option
• Delete Product Option - Delete a product option
• Upload Product Option Image - Upload image for a product option

note

Additional endpoints for Products, Orders, Home Sections, Home Banners, Reels, Content Pages, and Notifications are available but documentation is pending. These endpoints are functional in the API.