docs: Update software updates API documentation for structured changelogs
This commit is contained in:
@@ -59,7 +59,19 @@ POST /wp-json/woonoow/v1/software/check
|
|||||||
},
|
},
|
||||||
"current_version": "1.0.0",
|
"current_version": "1.0.0",
|
||||||
"latest_version": "1.2.0",
|
"latest_version": "1.2.0",
|
||||||
"changelog": "## What's New\n- Added feature X\n- Fixed bug Y",
|
"changelog": {
|
||||||
|
"narrative": "Here the new features coming",
|
||||||
|
"points": [
|
||||||
|
{
|
||||||
|
"type": "ADD",
|
||||||
|
"text": "Added feature X"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "FIX",
|
||||||
|
"text": "Fixed bug Y"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
"release_date": "2026-02-01 12:00:00",
|
"release_date": "2026-02-01 12:00:00",
|
||||||
"download_url": "https://your-store.com/wp-json/woonoow/v1/software/download?token=..."
|
"download_url": "https://your-store.com/wp-json/woonoow/v1/software/download?token=..."
|
||||||
}
|
}
|
||||||
@@ -96,6 +108,34 @@ GET /wp-json/woonoow/v1/software/changelog?slug=<slug>&version=<version>
|
|||||||
|
|
||||||
Returns version history with changelogs.
|
Returns version history with changelogs.
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"slug": "my-plugin",
|
||||||
|
"versions": [
|
||||||
|
{
|
||||||
|
"version": "1.1.2",
|
||||||
|
"release_date": "2026-06-03 20:52:35",
|
||||||
|
"changelog": {
|
||||||
|
"narrative": "Here the new features coming",
|
||||||
|
"points": [
|
||||||
|
{
|
||||||
|
"type": "ADD",
|
||||||
|
"text": "Feature 1"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "FIX",
|
||||||
|
"text": "Feature 2 Stable"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"download_count": 0
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## WordPress Client Integration
|
## WordPress Client Integration
|
||||||
|
|
||||||
Include the updater class in your plugin or theme to enable automatic updates:
|
Include the updater class in your plugin or theme to enable automatic updates:
|
||||||
|
|||||||
@@ -112,8 +112,8 @@ Override the commission for a specific affiliate:
|
|||||||
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
┌─────────────┐ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐
|
||||||
│ Customer │ │ Affiliate │ │ Customer │ │ Order │
|
│ Customer │ │ Affiliate │ │ Customer │ │ Order │
|
||||||
│ clicks ref │ │ shares URL │ │ makes purch│ │ created │
|
│ clicks ref │ │ shares URL │ │ makes purch│ │ created │
|
||||||
│ link ?ref= │────▶│ w/ code │────▶│ via cookie │────▶│ + tracking │
|
│ link /ref/ │────▶│ w/ slug │────▶│ via cookie │────▶│ + tracking │
|
||||||
│ ABC123 │ │ │ │ stored │ │ recorded │
|
│ john-doe │ │ │ │ stored │ │ recorded │
|
||||||
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
└─────────────┘ └─────────────┘ └─────────────┘ └─────────────┘
|
||||||
│
|
│
|
||||||
▼
|
▼
|
||||||
@@ -179,7 +179,7 @@ For affiliates running generic ads (like TikTok bio links or Facebook Ads), Smar
|
|||||||
|
|
||||||
Affiliates can access their dashboard from **My Account > Affiliate Program**:
|
Affiliates can access their dashboard from **My Account > Affiliate Program**:
|
||||||
|
|
||||||
- **Referral link**: Unique URL with their code (e.g., `/shop?ref=ABC123`)
|
- **Referral link**: Short and clean unique URL with their slug (e.g., `/ref/john-doe`)
|
||||||
- **Link Builder**: Tool to generate referral links to specific products or pages.
|
- **Link Builder**: Tool to generate referral links to specific products or pages.
|
||||||
- **My Collections & Smart Links**: Tool to curate product collections and get auto-rotating Smart Links.
|
- **My Collections & Smart Links**: Tool to curate product collections and get auto-rotating Smart Links.
|
||||||
- **Statistics**: Total earnings, pending earnings, commission rate
|
- **Statistics**: Total earnings, pending earnings, commission rate
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ WooNooW comes with a powerful suite of marketing tools to help you retain custom
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
* **[Affiliate Program](/docs/marketing/affiliates)**: Build a partner network with cookie-based tracking and 3-level commission hierarchy.
|
||||||
* **[Newsletter](/docs/marketing/newsletter)**: Create campaigns and manage subscribers directly from your dashboard.
|
* **[Newsletter](/docs/marketing/newsletter)**: Create campaigns and manage subscribers directly from your dashboard.
|
||||||
* **[Coupons](/docs/marketing/coupons)**: Create smart coupons and automatic discounts.
|
* **[Coupons](/docs/marketing/coupons)**: Create smart coupons and automatic discounts.
|
||||||
* **[Wishlist](/docs/marketing/wishlist)**: Let customers save their favorite items for later.
|
* **[Wishlist](/docs/marketing/wishlist)**: Let customers save their favorite items for later.
|
||||||
|
|||||||
@@ -11,32 +11,38 @@ To use Subscriptions, ensure:
|
|||||||
2. Your payment gateway supports tokenization / recurring payments (e.g., Stripe, PayPal).
|
2. Your payment gateway supports tokenization / recurring payments (e.g., Stripe, PayPal).
|
||||||
|
|
||||||
## Creating a Subscription Product
|
## Creating a Subscription Product
|
||||||
1. Go to **Products > Add New** in WordPress.
|
|
||||||
2. In the Product Data dropdown, select **Simple Subscription** or **Variable Subscription**.
|
WooNooW implements subscriptions directly within the standard product settings, eliminating the need for separate product types.
|
||||||
|
|
||||||
|
1. Go to **Products** in the Admin SPA and create or edit a product.
|
||||||
|
2. In the **General** tab, scroll down and check **Enable subscription for this product**.
|
||||||
3. Configure the billing schedule:
|
3. Configure the billing schedule:
|
||||||
- **Subscription Price:** The recurring amount (e.g., $15).
|
- **Period & Interval:** How often they are charged (e.g., every 1 month).
|
||||||
- **Billing Interval/Period:** How often they are charged (e.g., every 1 month).
|
- **Trial Days:** Offer an initial period at no cost (e.g., 14 days).
|
||||||
- **Expire After:** When the subscription automatically ends (leave empty for "Never expire").
|
- **Signup Fee:** Optional one-time fee added to the first payment.
|
||||||
- **Sign-up Fee:** Optional one-time fee added to the first payment.
|
|
||||||
- **Free Trial:** Offer an initial period at no cost (e.g., 14 days).
|
> [!NOTE]
|
||||||
4. Publish the product.
|
> For variable products, you can configure these subscription settings at the variation level in the **Variations** tab, allowing different billing terms for different variations.
|
||||||
|
|
||||||
## Managing Subscriptions (Admin)
|
## Managing Subscriptions (Admin)
|
||||||
Store owners can view and manage all active, paused, or cancelled subscriptions directly from the Admin SPA.
|
Store owners can view and manage all active, paused, or cancelled subscriptions directly from the Admin SPA.
|
||||||
1. Navigate to **Store > Subscriptions**.
|
1. Navigate to **Store > Subscriptions**.
|
||||||
2. Click on any Subscription ID to view details.
|
2. Click on any Subscription ID to view details.
|
||||||
3. From the detail view, you can:
|
3. From the detail view, you can:
|
||||||
- **Pause** an active subscription.
|
- **Pause/Resume** an active subscription.
|
||||||
- **Cancel** a subscription.
|
- **Cancel** a subscription.
|
||||||
- **Change Next Payment Date**.
|
- **Renew Now**: Initiates a standard renewal process.
|
||||||
- **Process Renewal** manually.
|
- **Charge Now**: Bypasses gateway capability checks to attempt an immediate auto-debit charge. If it fails, the order is marked as failed without falling back to a manual payment link.
|
||||||
|
|
||||||
## Customer Experience
|
## Customer Experience
|
||||||
When a customer purchases a subscription, they gain access to a self-service dashboard in their account:
|
When a customer purchases a subscription, they gain access to a self-service dashboard in their account:
|
||||||
|
|
||||||
1. Customers navigate to **My Account > Subscriptions**.
|
1. Customers navigate to **My Account > Subscriptions**.
|
||||||
2. They can view the status, next payment date, and associated orders.
|
2. They can view the status, next payment date, and associated orders.
|
||||||
3. They have full autonomy to actions like **Pause**, **Resume**, or **Cancel** their own subscriptions based on the permissions you configure in the module settings.
|
3. They have autonomy to take actions like **Pause**, **Resume**, or **Cancel** their own subscriptions.
|
||||||
4. If a payment fails, customers will see a clear **Pay Now** button to update their billing details.
|
- **Pause Limits:** If configured in settings, customers are restricted to a maximum number of pauses (e.g., max 3 pauses per subscription). The UI clearly displays how many pauses are remaining.
|
||||||
|
4. **Early Renewals:** Customers can choose to renew early. When paying for an early renewal, the UI clearly displays the projected next billing date so they know exactly when their subsequent charge will occur.
|
||||||
|
5. If a payment fails, customers will see a clear **Pay Now** button to update their billing details.
|
||||||
|
|
||||||
## Automated Emails
|
## Automated Emails
|
||||||
The notification system automatically handles subscription lifecycle events:
|
The notification system automatically handles subscription lifecycle events:
|
||||||
|
|||||||
Reference in New Issue
Block a user