FluentCart REST API

FluentCart provides a comprehensive REST API that allows developers to interact with all e-commerce functionality programmatically. The API is built on WordPress's REST API foundation with FluentCart-specific endpoints and authentication.

API Overview

The FluentCart REST API provides programmatic access to:

• Order Management - Create, read, update, and manage orders
• Customer Management - Handle customer data and relationships
• Product Management - Manage products, variations, and pricing
• Payment Processing - Handle payments and transactions
• Subscription Management - Manage recurring subscriptions
• Coupon System - Apply and manage discount coupons
• File Management - Handle file uploads and downloads
• Settings Management - Configure store and module settings

Base URL

All API endpoints are prefixed with the WordPress REST API base URL:

https://yoursite.com/wp-json/fluent-cart/v2/

Authentication

FluentCart uses WordPress's built-in authentication system with additional policy-based authorization:

1. WordPress Authentication

• Cookie Authentication - For logged-in users
• Application Passwords - For external applications
• OAuth - For third-party integrations

2. Policy-Based Authorization

FluentCart implements a policy system for fine-grained access control:

• AdminPolicy - Super admin access
• OrderPolicy - Order management permissions
• CustomerPolicy - Customer management permissions
• ProductPolicy - Product management permissions
• CouponPolicy - Coupon management permissions

Authentication Example

// Using WordPress Application Passwords
$headers = [
    'Authorization' => 'Basic ' . base64_encode('username:application_password'),
    'Content-Type' => 'application/json'
];

$response = wp_remote_get('https://yoursite.com/wp-json/fluent-cart/v1/orders', [
    'headers' => $headers
]);

Response Format

All API responses follow a consistent JSON format:

Success Response

{
    "success": true,
    "data": {
        // Response data
    },
    "message": "Operation completed successfully"
}

Error Response

{
    "success": false,
    "error": {
        "code": "error_code",
        "message": "Error description"
    }
}

Pagination

List endpoints support pagination using WordPress's standard pagination parameters:

• page - Page number (default: 1)
• per_page - Items per page (default: 10, max: 100)

Pagination Response

{
    "data": [...],
    "pagination": {
        "current_page": 1,
        "per_page": 10,
        "total": 100,
        "total_pages": 10
    }
}

Core Endpoints

Orders API

• GET /orders - List orders
• POST /orders - Create order
• GET /orders/{id} - Get order details
• PUT /orders/{id} - Update order
• DELETE /orders/{id} - Delete order
• POST /orders/{id}/mark-as-paid - Mark order as paid
• POST /orders/{id}/refund - Refund order
• PUT /orders/{id}/statuses - Update order statuses

View Orders API Documentation →

Customers API

• GET /customers - List customers
• POST /customers - Create customer
• GET /customers/{id} - Get customer details
• PUT /customers/{id} - Update customer
• GET /customers/{id}/orders - Get customer orders
• GET /customers/{id}/address - Get customer addresses
• PUT /customers/{id}/address - Update customer address

View Customers API Documentation →

Products API

• GET /products - List products
• POST /products - Create product
• GET /products/{id} - Get product details
• PUT /products/{id} - Update product
• DELETE /products/{id} - Delete product
• GET /products/variants - List product variations
• POST /products/variants - Create product variation
• PUT /products/variants/{id} - Update product variation

View Products API Documentation →

Subscriptions API

• GET /subscriptions - List subscriptions
• GET /subscriptions/{id} - Get subscription details
• PUT /subscriptions/{id} - Update subscription
• POST /subscriptions/{id}/cancel - Cancel subscription
• POST /subscriptions/{id}/reactivate - Reactivate subscription

View Subscriptions API Documentation →

Coupons API

• GET /coupons - List coupons
• POST /coupons - Create coupon
• GET /coupons/{id} - Get coupon details
• PUT /coupons/{id} - Update coupon
• DELETE /coupons/{id} - Delete coupon
• POST /coupons/apply - Apply coupon
• POST /coupons/cancel - Cancel coupon

Settings API

• GET /settings/store - Get store settings
• POST /settings/store - Update store settings
• GET /settings/payment-methods - Get payment method settings
• POST /settings/payment-methods - Update payment method settings
• GET /settings/storage-drivers - Get storage driver settings
• POST /settings/storage-drivers - Update storage driver settings

File Management API

• GET /files - List files
• POST /files/upload - Upload file
• DELETE /files/delete - Delete file
• GET /files/bucket-list - Get file bucket list

Integration API

• GET /integration/global-settings - Get global integration settings
• POST /integration/global-settings - Update global integration settings
• GET /integration/global-feeds - Get integration feeds
• POST /integration/global-feeds/settings - Save integration feed settings

Reports API

• GET /reports/overview - Get overview report
• GET /reports/orders - Get order report
• GET /reports/customers - Get customer report
• GET /reports/products - Get product report
• GET /reports/revenue - Get revenue report

Pro Endpoints ⭐ PRO ONLY

Licensing API (Pro)

• GET /licenses - List licenses
• POST /licenses - Create license
• GET /licenses/{id} - Get license details
• PUT /licenses/{id} - Update license
• POST /licenses/{id}/activate - Activate license

View Licensing API Documentation →

Roles & Permissions API (Pro)

• GET /settings/permissions - Get permissions
• POST /settings/permissions - Update permissions
• GET /users/{id}/capabilities - Get user capabilities
• POST /users/{id}/capabilities - Update user capabilities

View Roles & Permissions API Documentation →

Order Bump API (Pro)

• GET /order-bumps - List order bumps
• POST /order-bumps - Create order bump
• GET /order-bumps/{id} - Get order bump details
• PUT /order-bumps/{id} - Update order bump
• DELETE /order-bumps/{id} - Delete order bump

View Order Bump API Documentation →

Frontend Endpoints

Cart API

• GET /cart - Get cart contents
• POST /cart/add - Add item to cart
• PUT /cart/update - Update cart item
• DELETE /cart/remove - Remove item from cart
• POST /cart/apply-coupon - Apply coupon to cart

Checkout API

• POST /checkout/process - Process checkout
• GET /checkout/shipping-methods - Get shipping methods
• POST /checkout/calculate-shipping - Calculate shipping

Public API

• GET /public/products - Get public product catalog
• GET /public/products/{id} - Get public product details
• GET /public/categories - Get product categories

Error Handling

The API uses standard HTTP status codes:

• 200 - Success
• 201 - Created
• 400 - Bad Request
• 401 - Unauthorized
• 403 - Forbidden
• 404 - Not Found
• 422 - Validation Error
• 500 - Internal Server Error

Error Response Example

{
    "success": false,
    "error": {
        "code": "validation_error",
        "message": "The given data was invalid.",
        "details": {
            "email": ["The email field is required."],
            "name": ["The name field must be at least 3 characters."]
        }
    }
}

Rate Limiting

API requests are subject to rate limiting to prevent abuse:

• Authenticated requests: 1000 requests per hour
• Unauthenticated requests: 100 requests per hour
• Bulk operations: 10 requests per hour

Rate limit headers are included in responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Webhooks

FluentCart supports webhooks for real-time notifications:

• POST /webhook/feed - Create webhook
• GET /webhook/feed - List webhooks
• GET /webhook/feed/{id} - Get webhook details
• PUT /webhook/feed/{id} - Update webhook
• DELETE /webhook/feed/{id} - Delete webhook

Webhook Events

• order.created - Order created
• order.updated - Order updated
• order.paid - Order paid
• subscription.created - Subscription created
• subscription.cancelled - Subscription cancelled
• payment.success - Payment successful
• payment.failed - Payment failed

SDK and Libraries

JavaScript SDK

import FluentCartAPI from 'fluent-cart-sdk';

const api = new FluentCartAPI({
    baseURL: 'https://yoursite.com/wp-json/fluent-cart/v1',
    apiKey: 'your-api-key'
});

// Get orders
const orders = await api.orders.list();

// Create order
const order = await api.orders.create({
    customer_id: 123,
    items: [
        { product_id: 456, quantity: 2 }
    ]
});

PHP SDK

use FluentCart\API\Client;

$client = new Client([
    'base_url' => 'https://yoursite.com/wp-json/fluent-cart/v1',
    'api_key' => 'your-api-key'
]);

// Get orders
$orders = $client->orders()->list();

// Create order
$order = $client->orders()->create([
    'customer_id' => 123,
    'items' => [
        ['product_id' => 456, 'quantity' => 2]
    ]
]);

Testing

Postman Collection

Download the FluentCart API Postman collection for easy testing: Download Postman Collection

API Testing Tools

• Postman - GUI-based API testing
• Insomnia - Alternative API testing tool
• curl - Command-line testing
• HTTPie - User-friendly command-line tool

Example curl Commands

# Get orders
curl -X GET "https://yoursite.com/wp-json/fluent-cart/v1/orders" \
  -H "Authorization: Basic dXNlcm5hbWU6YXBwbGljYXRpb25fcGFzc3dvcmQ="

# Create order
curl -X POST "https://yoursite.com/wp-json/fluent-cart/v1/orders" \
  -H "Authorization: Basic dXNlcm5hbWU6YXBwbGljYXRpb25fcGFzc3dvcmQ=" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": 123,
    "items": [
      {"product_id": 456, "quantity": 2}
    ]
  }'

Support and Resources

Community Support

• GitHub Issues - Bug reports and feature requests
• Developer Community - Community discussions
• Documentation Issues - Documentation improvements

Professional Support

• API Support - Priority support for API issues
• Custom Development - Custom API integrations
• Training - API development training

Related Documentation

• Database Models - Data models used by API endpoints
• Developer Hooks - Hooks triggered by API operations
• Module System - Modules that extend API functionality
• Frontend Development - Frontend API integration
• Integration Guide - Third-party API integrations

Next Steps

Continue with API development:

1. Authentication Guide - Learn about API authentication
2. Orders API - Start with order management endpoints
3. Customers API - Customer management endpoints
4. Products API - Product catalog endpoints

Previous/Next Navigation

• Previous: Developer Hooks - Extending FluentCart functionality
• Next: Module System - Building custom modules

---