Màn hình dựng sẵn #
Mọi màn hình module MÔ TẢ bằng dữ liệu ở bản server này (sdk/screens.json,
sinh cùng SDK). CMS đọc mô tả lúc chạy qua getMenuScreen — trang này để
đối chiếu: renderer chung đã hỗ trợ đủ type / widget chưa, màn hình nào
dựng được. Cách vẽ: CMS §3.1 ,
hướng dẫn từng bước: Màn hình chung .
Loại đang dùng: crud. Widget đang dùng: badge, boolean, datetime, email, file, image, money, multipicker, number, picker, qty, select, switch, text, textarea, translations, url, user.
brand.brands #
Module brand · type: crud · revision: 320da6755a33b82f · tiêu đề: Brands (en), Thương hiệu (vi).
Operation: list = listBrands · get = getBrand · create = createBrand · update = updateBrand · delete = deleteBrand. Tìm (q): có. Thùng rác: listBrandTrash + restoreBrand.
Cột #
Field Widget Sắp theo Ghi chú Nhãn (en) Nhãn (vi) logoFileInfoimagetải: downloadFile Logo Logo codetheo schema codeCode Mã nametheo schema Name Tên activeswitchActive Đang dùng sortOrdernumbersort_orderOrder Thứ tự updatedAtdatetimeupdated_atUpdated Cập nhật
Bộ lọc #
Tham số Widget Lựa chọn Nhãn (en) Nhãn (vi) activebooleanActive Đang dùng
Field Widget Form Bắt buộc Ghi chú Nhãn (en) Nhãn (vi) codetextcreate, update create Code Mã translationstranslationscreate, update — Translations Bản dịch translations[].nametextcreate, update create, update Name Tên translations[].descriptiontextareacreate, update — Description Mô tả translations[].slugtextcreate, update — Slug Slug translations[].metaTitletextcreate, update — Meta title Tiêu đề SEO translations[].metaDescriptiontextareacreate, update — Meta description Mô tả SEO websiteUrlurlcreate, update — Website Website logoFileIdfilecreate, update — hiện: logoFileInfo; tải lên: uploadFile; tải về: downloadFile Logo Logo sortOrdernumbercreate, update — Order Thứ tự activeswitchcreate, update — Active Đang dùng
Operation #
operationId Method Đường Quyền Tính năng gói createBrandPOST/api/v1/brandsbrand.createdeleteBrandDELETE/api/v1/brands/{id}brand.deletedownloadFileGET/api/v1/files/{id}/contentfiles.readgetBrandGET/api/v1/brands/{id}brand.readlistBrandsGET/api/v1/brandsbrand.readlistBrandTrashGET/api/v1/brands/trashbrand.restorerestoreBrandPOST/api/v1/brands/{id}/restorebrand.restoreupdateBrandPATCH/api/v1/brands/{id}brand.updateuploadFilePOST/api/v1/filesfiles.write
coupon.coupons #
Module coupon · type: crud · revision: c5697ae07858c6ec · tiêu đề: Coupons (en), Mã giảm giá (vi).
Operation: list = listCoupons · get = getCoupon · create = createCoupon · update = updateCoupon · delete = deleteCoupon. Tìm (q): có. Thùng rác: listCouponTrash + restoreCoupon.
Cột #
Field Widget Sắp theo Ghi chú Nhãn (en) Nhãn (vi) codetheo schema codeCode Mã nametheo schema nameName Tên discountTypebadgeenum discount_type Type Kiểu discountValueqtyValue Mức giảm customerInfo.nametheo schema Customer Khách hàng startsAtdatetimeStarts Bắt đầu endsAtdatetimeEnds Kết thúc redeemedCountnumberUsed Đã dùng activeswitchActive Đang dùng
Bộ lọc #
Tham số Widget Lựa chọn Nhãn (en) Nhãn (vi) activebooleanActive Đang dùng customer_idpickerlistCustomers → nameCustomer Khách hàng
Field Widget Form Bắt buộc Ghi chú Nhãn (en) Nhãn (vi) codetextcreate, update create Code Mã nametextcreate, update create Name Tên discountTypeselectcreate, update create enum discount_type Discount type Kiểu giảm discountValueqtycreate, update create Discount value Mức giảm maxDiscountmoneycreate, update — tiền tệ: currency Max discount Giảm tối đa minSubtotalmoneycreate, update — tiền tệ: currency Minimum subtotal Đơn tối thiểu startsAtdatetimecreate, update — Starts at Bắt đầu endsAtdatetimecreate, update — Ends at Kết thúc usageLimitnumbercreate, update — Usage limit Giới hạn lượt dùng perCustomerLimitnumbercreate, update — Limit per customer Giới hạn mỗi khách customerIdpickercreate, update — listCustomers → name; hiện: customerInfo.nameOnly for customer Chỉ cho khách productIdsmultipickercreate — listProductOptions → nameOnly for products Chỉ cho sản phẩm activeswitchcreate, update — Active Đang dùng notestextareacreate, update — Notes Ghi chú
Enum discount_type #
Giá trị Sắc thái Nhãn (en) Nhãn (vi) percentinfoPercent Phần trăm fixedneutralFixed amount Số tiền cố định
Operation #
operationId Method Đường Quyền Tính năng gói createCouponPOST/api/v1/couponscoupon.createdeleteCouponDELETE/api/v1/coupons/{id}coupon.deletegetCouponGET/api/v1/coupons/{id}coupon.readlistCouponsGET/api/v1/couponscoupon.readlistCouponTrashGET/api/v1/coupons/trashcoupon.restorelistCustomersGET/api/v1/core/customerscore.view_customerslistProductOptionsGET/api/v1/products/optionsproduct.readrestoreCouponPOST/api/v1/coupons/{id}/restorecoupon.restoreupdateCouponPATCH/api/v1/coupons/{id}coupon.update
customer_type_price_rule.customer_type_price_rules #
Module customer_type_price_rule · type: crud · revision: 6c0c059099c374b3 · tiêu đề: Customer type prices (en), Giá theo loại khách (vi).
Operation: list = listCustomerTypePriceRules · get = getCustomerTypePriceRule · create = createCustomerTypePriceRule · update = updateCustomerTypePriceRule · delete = deleteCustomerTypePriceRule. Tìm (q): không. Thùng rác: không.
Cột #
Field Widget Sắp theo Ghi chú Nhãn (en) Nhãn (vi) customerTypeInfo.nametheo schema Customer type Loại khách priceListInfo.nametheo schema Price list Bảng giá discountPctqtyDiscount % Giảm % startsAtdatetimeStarts Bắt đầu endsAtdatetimeEnds Kết thúc activeswitchActive Đang dùng updatedAtdatetimeupdated_atUpdated Cập nhật
Bộ lọc #
Tham số Widget Lựa chọn Nhãn (en) Nhãn (vi) customer_type_idpickerlistCustomerTypeOptions → nameCustomer type Loại khách price_list_idpickerlistPriceListOptions → namePrice list Bảng giá activebooleanActive Đang dùng
Field Widget Form Bắt buộc Ghi chú Nhãn (en) Nhãn (vi) customerTypeIdpickercreate create listCustomerTypeOptions → name (active=true); hiện: customerTypeInfo.nameCustomer type Loại khách priceListIdpickercreate create listPriceListOptions → name (active=true); hiện: priceListInfo.namePrice list Bảng giá discountPctqtycreate, update — Discount % Giảm % startsAtdatetimecreate, update — Starts at Bắt đầu endsAtdatetimecreate, update — Ends at Kết thúc activeswitchcreate, update — Active Đang dùng notestextareacreate, update — Notes Ghi chú
Operation #
operationId Method Đường Quyền Tính năng gói createCustomerTypePriceRulePOST/api/v1/customer-type-price-rulescustomer_type_price_rule.createdeleteCustomerTypePriceRuleDELETE/api/v1/customer-type-price-rules/{id}customer_type_price_rule.deletegetCustomerTypePriceRuleGET/api/v1/customer-type-price-rules/{id}customer_type_price_rule.readlistCustomerTypeOptionsGET/api/v1/customer-types/optionscustomer_type.readlistCustomerTypePriceRulesGET/api/v1/customer-type-price-rulescustomer_type_price_rule.readlistPriceListOptionsGET/api/v1/price-lists/optionsprice_list.readupdateCustomerTypePriceRulePATCH/api/v1/customer-type-price-rules/{id}customer_type_price_rule.update
customer_type.customer_types #
Module customer_type · type: crud · revision: ed3c1b2e3fe75709 · tiêu đề: Customer types (en), Loại khách (vi).
Operation: list = listCustomerTypes · get = getCustomerType · create = createCustomerType · update = updateCustomerType · delete = deleteCustomerType. Tìm (q): có. Thùng rác: listCustomerTypeTrash + restoreCustomerType.
Cột #
Field Widget Sắp theo Ghi chú Nhãn (en) Nhãn (vi) codetheo schema codeCode Mã nametheo schema nameName Tên activeswitchActive Đang dùng updatedAtdatetimeupdated_atUpdated Cập nhật
Bộ lọc #
Tham số Widget Lựa chọn Nhãn (en) Nhãn (vi) activebooleanActive Đang dùng
Field Widget Form Bắt buộc Ghi chú Nhãn (en) Nhãn (vi) codetextcreate, update create Code Mã nametextcreate, update create Name Tên activeswitchcreate, update — Active Đang dùng notestextareacreate, update — Notes Ghi chú
Operation #
operationId Method Đường Quyền Tính năng gói createCustomerTypePOST/api/v1/customer-typescustomer_type.createdeleteCustomerTypeDELETE/api/v1/customer-types/{id}customer_type.deletegetCustomerTypeGET/api/v1/customer-types/{id}customer_type.readlistCustomerTypesGET/api/v1/customer-typescustomer_type.readlistCustomerTypeTrashGET/api/v1/customer-types/trashcustomer_type.restorerestoreCustomerTypePOST/api/v1/customer-types/{id}/restorecustomer_type.restoreupdateCustomerTypePATCH/api/v1/customer-types/{id}customer_type.update
pre_order_setting.pre_order_settings #
Module pre_order_setting · type: crud · revision: 4170a15d68f13176 · tiêu đề: Pre-order settings (en), Đặt trước / bán vượt tồn (vi).
Operation: list = listPreOrderSettings · get = getPreOrderSetting · create = createPreOrderSetting · update = updatePreOrderSetting · delete = deletePreOrderSetting. Tìm (q): không. Thùng rác: listPreOrderSettingTrash + restorePreOrderSetting.
Cột #
Field Widget Sắp theo Ghi chú Nhãn (en) Nhãn (vi) variantInfo.productNametheo schema Product Sản phẩm variantInfo.skutheo schema SKU SKU allowBackorderswitchAllow backorder Cho bán vượt maxBackorderQtyqtyMax backorder Bán vượt tối đa expectedRestockAtdatetimeExpected restock Dự kiến về hàng updatedAtdatetimeupdated_atUpdated Cập nhật
Bộ lọc #
Tham số Widget Lựa chọn Nhãn (en) Nhãn (vi) allow_backorderbooleanAllow backorder Cho bán vượt variant_idpickerlistProductVariantOptions → productNameProduct variant Biến thể sản phẩm
Field Widget Form Bắt buộc Ghi chú Nhãn (en) Nhãn (vi) variantIdpickercreate create listProductVariantOptions → productName; hiện: variantInfo.productNameProduct variant Biến thể sản phẩm allowBackorderswitchcreate, update — Allow backorder Cho bán vượt maxBackorderQtyqtycreate, update — Max backorder quantity Bán vượt tối đa expectedRestockAtdatetimecreate, update — Expected restock Dự kiến về hàng notestextareacreate, update — Notes Ghi chú
Operation #
operationId Method Đường Quyền Tính năng gói createPreOrderSettingPOST/api/v1/pre-order-settingspre_order_setting.createdeletePreOrderSettingDELETE/api/v1/pre-order-settings/{id}pre_order_setting.deletegetPreOrderSettingGET/api/v1/pre-order-settings/{id}pre_order_setting.readlistPreOrderSettingsGET/api/v1/pre-order-settingspre_order_setting.readlistPreOrderSettingTrashGET/api/v1/pre-order-settings/trashpre_order_setting.restorelistProductVariantOptionsGET/api/v1/products/variants/optionsproduct.readrestorePreOrderSettingPOST/api/v1/pre-order-settings/{id}/restorepre_order_setting.restoreupdatePreOrderSettingPATCH/api/v1/pre-order-settings/{id}pre_order_setting.update
product_category.categories #
Module product_category · type: crud · revision: ff09bcfd9ff0f693 · tiêu đề: Product categories (en), Danh mục sản phẩm (vi).
Operation: list = listProductCategories · get = getProductCategory · create = createProductCategory · update = updateProductCategory · delete = deleteProductCategory. Tìm (q): có. Thùng rác: không.
Cột #
Field Widget Sắp theo Ghi chú Nhãn (en) Nhãn (vi) imageFileInfoimagetải: downloadFile Image Ảnh codetheo schema codeCode Mã nametheo schema Name Tên parentInfo.nametheo schema Parent Danh mục cha sortOrdernumbersort_orderOrder Thứ tự activeswitchActive Đang dùng updatedAtdatetimeupdated_atUpdated Cập nhật
Bộ lọc #
Tham số Widget Lựa chọn Nhãn (en) Nhãn (vi) activebooleanActive Đang dùng parent_idpickerlistProductCategoryOptions → nameParent Danh mục cha
Field Widget Form Bắt buộc Ghi chú Nhãn (en) Nhãn (vi) codetextcreate, update create Code Mã translationstranslationscreate, update — Translations Bản dịch translations[].nametextcreate, update create, update Name Tên translations[].descriptiontextareacreate, update — Description Mô tả translations[].slugtextcreate, update — Slug Slug translations[].metaTitletextcreate, update — Meta title Tiêu đề SEO translations[].metaDescriptiontextareacreate, update — Meta description Mô tả SEO parentIdpickercreate, update — listProductCategoryOptions → name; hiện: parentInfo.nameParent Danh mục cha imageFileIdfilecreate, update — hiện: imageFileInfo; tải lên: uploadFile; tải về: downloadFile Image Ảnh sortOrdernumbercreate, update — Order Thứ tự activeswitchcreate, update — Active Đang dùng
Operation #
operationId Method Đường Quyền Tính năng gói createProductCategoryPOST/api/v1/product-categoriesproduct_category.createdeleteProductCategoryDELETE/api/v1/product-categories/{id}product_category.deletedownloadFileGET/api/v1/files/{id}/contentfiles.readgetProductCategoryGET/api/v1/product-categories/{id}product_category.readlistProductCategoriesGET/api/v1/product-categoriesproduct_category.readlistProductCategoryOptionsGET/api/v1/product-categories/optionsproduct_category.readupdateProductCategoryPATCH/api/v1/product-categories/{id}product_category.updateuploadFilePOST/api/v1/filesfiles.write
stock.levels #
Module stock · type: crud · revision: 5d55965caa33384f · tiêu đề: Stock levels (en), Tồn kho (vi).
Operation: list = listStockLevels · get = getStockLevel · create = — · update = updateStockLevel · delete = —. Tìm (q): không. Thùng rác: không.
Cột #
Field Widget Sắp theo Ghi chú Nhãn (en) Nhãn (vi) warehouseInfo.nametheo schema Warehouse Kho variantInfo.productNametheo schema Product Sản phẩm variantInfo.skutheo schema SKU SKU locationInfo.nametheo schema Location Vị trí trackingModebadgeenum tracking_mode Tracking Theo dõi onHandqtyOn hand Tồn thực reservedqtyReserved Đã giữ availableqtyavailableAvailable Có thể bán lowStockThresholdqtyLow stock at Ngưỡng thấp isLowswitchLow Tồn thấp updatedAtdatetimeupdated_atUpdated Cập nhật
Bộ lọc #
Tham số Widget Lựa chọn Nhãn (en) Nhãn (vi) warehouse_idpickerlistWarehouseOptions → nameWarehouse Kho variant_idpickerlistProductVariantOptions → productNameProduct variant Biến thể sản phẩm is_lowbooleanLow stock Tồn thấp
Field Widget Form Bắt buộc Ghi chú Nhãn (en) Nhãn (vi) lowStockThresholdqtyupdate — Low stock threshold Ngưỡng tồn thấp
Enum tracking_mode #
Giá trị Sắc thái Nhãn (en) Nhãn (vi) noneneutralNone Không theo dõi batchinfoBatch Theo lô serialinfoSerial Theo serial
Operation #
operationId Method Đường Quyền Tính năng gói getStockLevelGET/api/v1/stock/levels/{id}stock.readlistProductVariantOptionsGET/api/v1/products/variants/optionsproduct.readlistStockLevelsGET/api/v1/stock/levelsstock.readlistWarehouseOptionsGET/api/v1/warehouses/optionswarehouse.readupdateStockLevelPATCH/api/v1/stock/levels/{id}stock.adjust
supplier.suppliers #
Module supplier · type: crud · revision: 21c7fc38b65951b6 · tiêu đề: Suppliers (en), Nhà cung cấp (vi).
Operation: list = listSuppliers · get = getSupplier · create = createSupplier · update = updateSupplier · delete = deleteSupplier. Tìm (q): có. Thùng rác: listSupplierTrash + restoreSupplier.
Cột #
Field Widget Sắp theo Ghi chú Nhãn (en) Nhãn (vi) codetheo schema codeCode Mã nametheo schema nameName Tên contactNametheo schema Contact Người liên hệ contactPhonetheo schema Phone Số điện thoại activeswitchActive Đang dùng updatedAtdatetimeupdated_atUpdated Cập nhật
Bộ lọc #
Tham số Widget Lựa chọn Nhãn (en) Nhãn (vi) activebooleanActive Đang dùng
Field Widget Form Bắt buộc Ghi chú Nhãn (en) Nhãn (vi) codetextcreate, update create Code Mã nametextcreate, update create Name Tên contactNametextcreate, update — Contact name Người liên hệ contactEmailemailcreate, update — Contact email Email liên hệ contactPhonetextcreate, update — Contact phone Số điện thoại addresstextareacreate, update — Address Địa chỉ taxCodetextcreate, update — Tax code Mã số thuế paymentTermsDaysnumbercreate, update — Payment terms (days) Hạn thanh toán (ngày) activeswitchcreate, update — Active Đang dùng notestextareacreate, update — Notes Ghi chú
Operation #
operationId Method Đường Quyền Tính năng gói createSupplierPOST/api/v1/supplierssupplier.createdeleteSupplierDELETE/api/v1/suppliers/{id}supplier.deletegetSupplierGET/api/v1/suppliers/{id}supplier.readlistSuppliersGET/api/v1/supplierssupplier.readlistSupplierTrashGET/api/v1/suppliers/trashsupplier.restorerestoreSupplierPOST/api/v1/suppliers/{id}/restoresupplier.restoreupdateSupplierPATCH/api/v1/suppliers/{id}supplier.update
uom.uoms #
Module uom · type: crud · revision: 9089e9034ddbf16c · tiêu đề: Units of measure (en), Đơn vị tính (vi).
Operation: list = listUoms · get = getUom · create = createUom · update = updateUom · delete = deleteUom. Tìm (q): có. Thùng rác: listUomTrash + restoreUom.
Cột #
Field Widget Sắp theo Ghi chú Nhãn (en) Nhãn (vi) codetheo schema codeCode Mã nametheo schema Name Tên symboltheo schema Symbol Ký hiệu categorybadgecategoryenum category Category Nhóm allowFractionswitchFractions Số lẻ activeswitchActive Đang dùng
Bộ lọc #
Tham số Widget Lựa chọn Nhãn (en) Nhãn (vi) activebooleanActive Đang dùng categoryselectenum category Category Nhóm
Field Widget Form Bắt buộc Ghi chú Nhãn (en) Nhãn (vi) codetextcreate, update create Code Mã categoryselectcreate, update create enum category Category Nhóm symboltextcreate, update — Symbol Ký hiệu allowFractionswitchcreate, update — Allow fractions Cho số lẻ activeswitchcreate, update — Active Đang dùng translationstranslationscreate — Translations Bản dịch translations[].nametextcreate create Name Tên
Enum category #
Giá trị Sắc thái Nhãn (en) Nhãn (vi) countCount Đếm weightWeight Khối lượng volumeVolume Thể tích lengthLength Chiều dài areaArea Diện tích timeTime Thời gian serviceService Dịch vụ digitalDigital Kỹ thuật số energyEnergy Năng lượng
Operation #
operationId Method Đường Quyền Tính năng gói createUomPOST/api/v1/uomsuom.createdeleteUomDELETE/api/v1/uoms/{id}uom.deletegetUomGET/api/v1/uoms/{id}uom.readlistUomsGET/api/v1/uomsuom.readlistUomTrashGET/api/v1/uoms/trashuom.restorerestoreUomPOST/api/v1/uoms/{id}/restoreuom.restoreupdateUomPATCH/api/v1/uoms/{id}uom.update
warehouse.warehouses #
Module warehouse · type: crud · revision: 2332e8656eea7e4d · tiêu đề: Warehouses (en), Kho hàng (vi).
Operation: list = listWarehouses · get = getWarehouse · create = createWarehouse · update = updateWarehouse · delete = deleteWarehouse. Tìm (q): có. Thùng rác: listWarehouseTrash + restoreWarehouse.
Cột #
Field Widget Sắp theo Ghi chú Nhãn (en) Nhãn (vi) codetheo schema codeCode Mã nametheo schema nameName Tên typebadgeenum type Type Loại citytheo schema City Thành phố isDefaultswitchDefault Mặc định prioritynumberpriorityPriority Ưu tiên activeswitchActive Đang dùng
Bộ lọc #
Tham số Widget Lựa chọn Nhãn (en) Nhãn (vi) activebooleanActive Đang dùng is_defaultbooleanDefault Mặc định typeselectenum type Type Loại
Field Widget Form Bắt buộc Ghi chú Nhãn (en) Nhãn (vi) codetextcreate, update create Code Mã nametextcreate, update create Name Tên typeselectcreate, update — enum type Type Loại addressLinetextcreate, update — Address Địa chỉ citytextcreate, update — City Thành phố phonetextcreate, update — Phone Điện thoại emailemailcreate, update — Email Email isDefaultswitchcreate, update — Default warehouse Kho mặc định activeswitchcreate, update — Active Đang dùng prioritynumbercreate, update — Priority Ưu tiên
Enum type #
Giá trị Sắc thái Nhãn (en) Nhãn (vi) physicalinfoPhysical Kho thật virtualneutralVirtual Kho ảo dropshipwarningDropship Dropship
Operation #
operationId Method Đường Quyền Tính năng gói createWarehousePOST/api/v1/warehouseswarehouse.createdeleteWarehouseDELETE/api/v1/warehouses/{id}warehouse.deletegetWarehouseGET/api/v1/warehouses/{id}warehouse.readlistWarehousesGET/api/v1/warehouseswarehouse.readlistWarehouseTrashGET/api/v1/warehouses/trashwarehouse.restorerestoreWarehousePOST/api/v1/warehouses/{id}/restorewarehouse.restoreupdateWarehousePATCH/api/v1/warehouses/{id}warehouse.update
wishlist.wishlist_items #
Module wishlist · type: crud · revision: b043163b3845de8d · tiêu đề: Wishlists (en), Danh sách yêu thích (vi).
Operation: list = listWishlistItems · get = — · create = — · update = — · delete = —. Tìm (q): không. Thùng rác: không.
Cột #
Field Widget Sắp theo Ghi chú Nhãn (en) Nhãn (vi) customerInfo.nametheo schema Customer Khách hàng variantInfo.productNametheo schema Product Sản phẩm variantInfo.optionsLabeltheo schema Variant Biến thể onSaleswitchOn sale Đang giảm giá createdAtdatetimecreated_atAdded Ngày thêm
Bộ lọc #
Tham số Widget Lựa chọn Nhãn (en) Nhãn (vi) customer_idpickerlistCustomers → nameCustomer Khách hàng variant_idpickerlistProductVariantOptions → productNameProduct variant Biến thể sản phẩm
Operation #
operationId Method Đường Quyền Tính năng gói listCustomersGET/api/v1/core/customerscore.view_customerslistProductVariantOptionsGET/api/v1/products/variants/optionsproduct.readlistWishlistItemsGET/api/v1/wishlistwishlist.read
Nguồn: xforge-modules: sdk/screens.json