GP247 Documentation (gp247-docs)
September 4, 2026 · View on GitHub
🌐 Language: 🇻🇳 Tiếng Việt · 🇬🇧 English (current)
GP247 Documentation (gp247-docs)
Introduction
This is the shared GP247 documentation repo. This page is the index listing all documents in the repo with links to each one. Documents are grouped by topic (API, extensions/plugins, system, S-Cart).
Document list
API
| Document | Summary | Last updated |
|---|---|---|
| GP247 API Introduction | Overview of the API system, authentication and how to call it | 2026-07-30 |
| How to build an API correctly | How to write a new API endpoint the GP247 way | 2026-07-30 |
Extensions (Plugins)
| Document | Summary | Last updated |
|---|---|---|
| Creating a Plugin (v2 standard) | Build a new v2-standard plugin that updates safely | 2026-08-23 |
| Creating a Template (storefront theme) | Build a new storefront template; the gp247/shop view fallback mechanism | 2026-08-23 |
| Installing Plugins & Templates | 4 methods: online (library), import (.zip), manual, CLI (gp247:ext-*) | 2026-08-24 |
| Converting a Plugin from v1 to v2 | Upgrade a plugin from Core 1.x to Core 2.0 | 2026-07-30 |
System
| Document | Summary | Last updated |
|---|---|---|
| GP247 v3.0 release notes — order money | Upgrading from v2.1/v3.0: payment ledger per order, cash flow counted by receipt date, payment status off-by-one fixed, discount taken before tax; note for plugin developers | 2026-09-04 |
| Command-Line (CLI) Reference | Reference for all GP247 CLI commands: --json/exit-code output contract, gp247:ext-* lifecycle, install/update/doctor/info; core-update runs the upgrade migrations (core 2.2) | 2026-08-29 |
| How to update GP247 | Safe update for a live site, prioritizing the standardized gp247:update; automatic data conversion since the public v2.1; --overwrite-lang, --publish options | 2026-08-29 |
| Multi-language system | Using languages / i18n in GP247 | 2026-07-30 |
| Mail system | Mail sending flow (with diagrams), SMTP config, channel selection | 2026-08-05 |
| Sensitive data encryption | At-rest secret encryption (SMTP/OAuth/license); dedicated GP247_ENCRYPTION_KEY; safe key-change steps with gp247:encryption-key-rotate; encrypting custom columns | 2026-09-04 |
| Scheduler & Queue | schedule:run vs queue:work; per-environment cron for mail | 2026-08-05 |
| Cache Handling | Config Cache Manager screen; what is/isn't cached; version-bump; helper functions | 2026-08-12 |
| Custom Fields | The 4 hook links; coverage limited to customer/product; dev guide to wire other tables | 2026-08-14 |
| Permissions (Permission · Role · User) | Admin RBAC: 3 building blocks, 2 special roles, address+method gating, strategy formula | 2026-08-16 |
S-Cart (store)
| Document | Summary | Last updated |
|---|---|---|
| Order lifecycle | Every stage of an order — placing, editing, receiving money, refunding, cancelling, re-opening, deleting — with stock/money/history at each, plus flow diagrams | 2026-08-29 |
| Currency | Explicit base currency, value-preserving rebase, money-input hint (from shop 2.1) | 2026-08-22 |
| Tax in GP247 | How per-product tax works and how to configure it | 2026-08-04 |
| Product Bundle (Combo) | Create a combo product of several child products; price & stock | 2026-08-04 |
| Product Structure (Single/Bundle/Group) | Compare the 3 product kinds with a chart; which to choose | 2026-08-04 |
| Product stock management | When stock decreases/returns; over-stock config; cancelling returns stock, deleting no longer does (changed in v3.0) | 2026-08-29 |
| Product Attributes (Color/Size) | Attribute groups & values + surcharge; admin setup; price/cart/order flow; price safety | 2026-08-13 |
| Product keyword tags (Product Tag) | Create/assign keyword tags to products; vs Delivery type; disable vs delete (from shop 2.1.6) | 2026-08-25 |
📅 Last updated: 2026-09-04 · ✍️ Author: GP247