Quick start
Install the module, enable pre-order, configure a 25% deposit, mark a product as pre-orderable, and run a test checkout — start to finish in ten minutes.
1. Install via Composer
composer require byte8/module-preorder
bin/magento module:enable Byte8_Preorder
bin/magento setup:upgrade
bin/magento setup:di:compile # only on production mode
bin/magento cache:flush
The module declares dependencies on Magento_CatalogInventory, Magento_Vault, Magento_Inventory* (MSI) and standard sales modules — Composer pulls those automatically if you haven't already disabled them.
2. Enable in admin
Go to Stores → Configuration → Byte8 → Pre-Order → General Settings:
| Field | Value |
|---|---|
| Enable Pre-Order | Yes |
| Allow Pre-Order When In Stock | No (recommended default) |
Then Payment Settings:
| Field | Value |
|---|---|
| Payment Type | Partial Payment (Percentage) |
| Deposit Type | Percentage |
| Deposit Amount | 25 |
Save config. Flush cache.
3. Mark a product as pre-orderable
Edit any catalog product. In the Pre-Order attribute group, set:
| Attribute | Value |
|---|---|
preorder_enabled | Yes |
preorder_available_from | A future date — e.g. 30 days out |
preorder_max_qty | (optional) cap units per order |
preorder_message | Reserve yours — ships {{availability_date}} |
Save. Flush full-page cache for that product.
4. Place a test pre-order
- Go to the product page on the storefront. The PDP info block now shows the deposit breakdown and availability date.
- Add to cart — the cart line shows the pre-order fee row.
- Checkout, pay with a vault-capable method (Stripe, Adyen, Braintree, etc.). The customer is charged 25% of the product price.
- Order placement triggers the pre-order entity creation, MSI reservation, and vault token storage.
5. Verify
Run the pre-order list CLI to see your booking:
bin/magento preorder:list
You should see the new pre-order with status pending, deposit captured, and balance owed.
What's next
- Configure vault capture — automate the balance charge on shipment. See Vault capture configuration.
- Read the data flow — pre-order lifecycle from PDP to ship-day capture. See Architecture overview.
- GraphQL — wire it into a VelaFront / Hydrogen storefront. See GraphQL.