RocketSavvy v3 API
Comprehensive digital transformation platform with enterprise-grade APIs for billing, commerce, communications, and business automation.
🔐 Authentication
RocketSavvy uses API keys for authentication. Include your API key in the Authorization header of all requests.
curl -H "Authorization: Bearer rs_live_key_..." \
-H "Content-Type: application/json" \
https://api.rocketsavvy.com/v3/customers
🚀 Quick Start
- Get your API keys from the RocketSavvy dashboard
- Install the RocketSavvy SDK for your platform
- Initialize the client with your API key
- Make your first API call
- Set up webhooks for real-time updates
💳 Billing & Subscription Management
Comprehensive subscription billing, customer management, and revenue operations with advanced metering and pricing models.
Create a new subscription with flexible billing cycles and pricing models.
-
customer_id
string
Unique customer identifier
-
plan_id
string
Subscription plan identifier
-
billing_cycle
enum
monthly, quarterly, yearly, usage_based
-
auto_collection
boolean
Enable automatic payment collection
{
"customer_id": "cust_rs_123456",
"plan_id": "plan_enterprise_pro",
"billing_cycle": "monthly",
"auto_collection": true,
"trial_period_days": 14,
"metadata": {
"source": "website",
"campaign": "q4_promo"
}
}
Retrieve detailed invoice information including line items, taxes, and payment status.
{
"id": "inv_rs_789012",
"customer_id": "cust_rs_123456",
"amount": 9999,
"currency": "USD",
"status": "paid",
"due_date": "2025-07-27",
"line_items": [...],
"taxes": [...],
"payment_method": "card_ending_4242"
}
Record usage metrics for metered billing and consumption-based pricing.
-
subscription_id
string
Target subscription for usage recording
-
metric_name
string
API calls, storage_gb, bandwidth_gb, etc.
-
quantity
number
Usage amount to record
🛍️ Commerce & Store Management
Multi-store e-commerce platform with advanced inventory management, order processing, and customer experience optimization.
Create products with variants, pricing tiers, and multi-channel distribution.
{
"name": "Premium Digital Service Package",
"sku": "PDS-PRO-001",
"price": 29999,
"currency": "USD",
"categories": ["digital-services", "enterprise"],
"variants": [
{
"name": "Basic",
"price": 19999,
"features": ["feature1", "feature2"]
}
],
"inventory": {
"track_quantity": false,
"unlimited": true
}
}
Retrieve comprehensive order information including fulfillment status and tracking.
{
"id": "ord_rs_345678",
"store_id": "store_main",
"customer_id": "cust_rs_123456",
"status": "processing",
"total_amount": 15999,
"currency": "USD",
"line_items": [...],
"shipping_address": {...},
"fulfillment": {
"status": "pending",
"tracking_number": null
}
}
Update inventory levels across multiple warehouses and sales channels.
-
warehouse_id
string
Target warehouse for stock update
-
quantity
number
New stock quantity
-
operation
enum
set, add, subtract
👥 Customer Relationship Management
Advanced CRM with B2B, B2C, and B2G customer management, segmentation, and lifecycle automation.
Create comprehensive customer profiles with custom fields and segmentation.
{
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"customer_type": "b2b",
"company": {
"name": "Acme Corporation",
"industry": "technology",
"size": "enterprise",
"annual_revenue": 10000000
},
"segments": ["enterprise", "technology"],
"custom_fields": {
"lead_source": "website",
"priority_level": "high"
}
}
Track complete customer journey including touchpoints, interactions, and engagement history.
{
"customer_id": "cust_rs_123456",
"lifecycle_stage": "customer",
"total_ltv": 45000,
"touchpoints": [
{
"timestamp": "2025-06-01T10:00:00Z",
"type": "website_visit",
"source": "organic_search"
},
{
"timestamp": "2025-06-15T14:30:00Z",
"type": "purchase",
"amount": 15000
}
],
"engagement_score": 85
}
Log customer interactions across all channels including calls, emails, and meetings.
-
type
enum
call, email, meeting, chat, support_ticket
-
direction
enum
inbound, outbound
-
notes
string
Interaction summary and notes
🏢 Enterprise Resource Planning
Integrated ERP solution with financial management, procurement, project tracking, and business intelligence.
Record financial transactions with multi-currency support and automated accounting.
{
"type": "revenue",
"amount": 25000,
"currency": "USD",
"account_code": "4000-REVENUE",
"description": "Professional services revenue",
"customer_id": "cust_rs_123456",
"project_id": "proj_website_redesign",
"tax_inclusive": false,
"payment_terms": "net_30"
}
Comprehensive project analytics including profitability, resource utilization, and timeline tracking.
{
"project_id": "proj_website_redesign",
"status": "in_progress",
"budget": 50000,
"spent": 32000,
"remaining": 18000,
"profitability": {
"margin_percent": 28.5,
"projected_profit": 14250
},
"timeline": {
"start_date": "2025-06-01",
"end_date": "2025-08-15",
"completion_percent": 65
}
}
Create purchase orders with vendor management and approval workflows.
-
vendor_id
string
Supplier/vendor identifier
-
items
array
List of items to purchase
-
approval_required
boolean
Requires management approval
📞 Communications & VoIP Platform
Complete communications suite with VoIP services, PBX management, number delegation, and advanced call routing.
Initiate outbound calls with advanced routing and recording capabilities.
{
"to_number": "+1234567890",
"from_number": "+1987654321",
"caller_id_name": "RocketSavvy Support",
"record_call": true,
"routing_options": {
"ring_timeout": 30,
"fallback_number": "+1555000111"
},
"metadata": {
"customer_id": "cust_rs_123456",
"call_purpose": "support"
}
}
Manage PBX extensions with advanced call forwarding and voicemail settings.
{
"extensions": [
{
"extension": "101",
"user_id": "user_john_doe",
"status": "available",
"forwarding": {
"enabled": true,
"destination": "+1234567890"
},
"voicemail": {
"enabled": true,
"greeting": "custom"
}
}
],
"total_count": 25
}
Provision new phone numbers with geographic and toll-free options.
-
number_type
enum
local, toll_free, international
-
area_code
string
Preferred area code (for local numbers)
-
features
array
sms, voice, fax capabilities
Comprehensive call analytics with duration tracking, quality metrics, and cost analysis.
{
"period": "last_30_days",
"total_calls": 1542,
"total_duration": 45780,
"average_duration": 29.7,
"call_quality": {
"average_mos": 4.2,
"jitter_avg": 12,
"packet_loss": 0.03
},
"costs": {
"total": 342.50,
"per_minute": 0.015
}
}
💰 Payment Processing
Secure payment processing with multi-gateway support, marketplace payments, and advanced fraud protection.
Process payments with intelligent routing and fraud detection.
{
"amount": 5000,
"currency": "USD",
"payment_method": {
"type": "card",
"card": {
"number": "4242424242424242",
"exp_month": 12,
"exp_year": 2027,
"cvc": "123"
}
},
"customer_id": "cust_rs_123456",
"description": "Professional services payment",
"fraud_protection": true
}
Process marketplace payments with automatic splits to connected accounts.
-
total_amount
number
Total payment amount
-
splits
array
Array of payment splits
-
platform_fee
number
Platform commission amount
Check payment status with detailed transaction information and settlement details.
{
"id": "pay_rs_789012",
"status": "succeeded",
"amount": 5000,
"currency": "USD",
"gateway": "primary_gateway",
"created": "2025-06-27T10:30:00Z",
"settlement": {
"expected_date": "2025-06-29",
"fees": 145
},
"risk_score": 32
}
📦 Logistics & Shipping Management
Comprehensive logistics platform with multi-carrier shipping, real-time tracking, and delivery optimization.
Create shipments with intelligent carrier selection and rate optimization.
{
"order_id": "ord_rs_345678",
"origin": {
"address": "123 Warehouse St",
"city": "Toronto",
"country": "CA",
"postal_code": "M5V 3A8"
},
"destination": {
"address": "456 Customer Ave",
"city": "Athens",
"country": "GR",
"postal_code": "10431"
},
"packages": [
{
"weight": 2.5,
"dimensions": {
"length": 30,
"width": 20,
"height": 15
},
"value": 15000
}
],
"service_level": "express"
}
Real-time shipment tracking with delivery updates and customer notifications.
{
"shipment_id": "ship_rs_567890",
"tracking_number": "RS1234567890",
"status": "in_transit",
"carrier": "express_courier",
"estimated_delivery": "2025-06-30T16:00:00Z",
"tracking_events": [
{
"timestamp": "2025-06-27T10:00:00Z",
"status": "picked_up",
"location": "Toronto, CA"
},
{
"timestamp": "2025-06-28T14:30:00Z",
"status": "in_transit",
"location": "Frankfurt, DE"
}
]
}
Get shipping rates from multiple carriers with delivery time estimates.
-
origin_postal
string
Origin postal/zip code
-
destination_postal
string
Destination postal/zip code
-
weight
number
Package weight in kg
Schedule package pickups with flexible time windows and special requirements.
{
"shipment_ids": ["ship_rs_567890", "ship_rs_567891"],
"pickup_date": "2025-06-28",
"time_window": {
"start": "09:00",
"end": "17:00"
},
"special_instructions": "Ring doorbell twice",
"contact": {
"name": "John Warehouse",
"phone": "+14165551234"
}
}
🏭 Warehouse Management System
Advanced warehouse operations with inventory tracking, pick/pack optimization, and multi-location management.
Real-time inventory levels across all warehouse locations with safety stock alerts.
{
"warehouse_id": "wh_toronto_main",
"inventory": [
{
"sku": "PDS-PRO-001",
"quantity": 150,
"reserved": 25,
"available": 125,
"location": "A1-B3-C5",
"safety_stock": 50,
"reorder_point": 75,
"last_updated": "2025-06-27T10:00:00Z"
}
],
"alerts": [
{
"type": "low_stock",
"sku": "PDS-PRO-002",
"current_stock": 45,
"reorder_point": 75
}
]
}
Generate optimized pick lists with route optimization and batch processing.
-
order_ids
array
Orders to include in pick list
-
warehouse_id
string
Target warehouse
-
optimize_route
boolean
Enable route optimization
Transfer inventory between warehouse locations with tracking and auditing.
{
"from_warehouse": "wh_toronto_main",
"to_warehouse": "wh_montreal_dist",
"items": [
{
"sku": "PDS-PRO-001",
"quantity": 50
}
],
"reference": "TRANSFER-2025-001",
"expected_arrival": "2025-06-30",
"carrier": "internal_transport"
}
Initiate cycle counts with variance tracking and automatic adjustments.
-
warehouse_id
string
Warehouse to audit
-
count_type
enum
full, partial, abc_analysis
-
skus
array
Specific SKUs to count (for partial)
🎁 Rewards & Loyalty Platform
Comprehensive loyalty program management with points, tiers, and personalized rewards.
Award points to customers with automated tier progression and bonus calculations.
{
"customer_id": "cust_rs_123456",
"points": 500,
"reason": "purchase",
"order_id": "ord_rs_345678",
"multiplier": 2.0,
"expires_at": "2026-06-27T00:00:00Z",
"metadata": {
"campaign": "summer_promo",
"category": "electronics"
}
}
Get customer loyalty balance with tier status and available rewards.
{
"customer_id": "cust_rs_123456",
"points_balance": 2750,
"tier": {
"current": "gold",
"points_to_next": 1250,
"next_tier": "platinum"
},
"lifetime_points": 15420,
"pending_points": 300,
"available_rewards": [
{
"id": "rew_discount_10",
"name": "10% Off Next Purchase",
"cost": 1000,
"expires": "2025-12-31"
}
]
}
Redeem points for rewards with validation and automatic delivery.
-
customer_id
string
Customer redeeming points
-
reward_id
string
Reward to redeem
-
points_used
number
Points to deduct
📊 Analytics & Business Intelligence
Real-time analytics and reporting across all business functions with predictive insights and custom dashboards.
Comprehensive revenue analytics with forecasting and trend analysis.
{
"period": "last_30_days",
"total_revenue": 245000,
"growth_rate": 15.3,
"breakdown": {
"subscriptions": 180000,
"one_time": 65000
},
"forecast": {
"next_30_days": 285000,
"confidence": 0.87
},
"trends": [
{
"date": "2025-06-01",
"revenue": 8500
}
]
}
Generate custom reports with automated scheduling and delivery options.
-
report_type
enum
financial, customer, inventory, sales
-
date_range
object
Start and end dates for report
-
format
enum
pdf, excel, csv, json
Real-time key performance indicators across all business areas.
{
"kpis": {
"customer_acquisition_cost": 125.50,
"customer_lifetime_value": 2850.00,
"monthly_recurring_revenue": 85000,
"churn_rate": 3.2,
"net_promoter_score": 72,
"gross_margin": 68.5,
"inventory_turnover": 8.3,
"order_fulfillment_time": 24.5
},
"updated_at": "2025-06-27T10:00:00Z"
}
🔔 Webhooks & Real-time Events
Configure webhooks to receive real-time notifications for all platform events with reliable delivery and retry logic.
Create webhook endpoints with event filtering and signature verification.
{
"url": "https://your-app.com/webhooks/rocketsavvy",
"events": [
"subscription.created",
"payment.succeeded",
"order.fulfilled",
"customer.updated"
],
"secret": "whsec_your_secret_key",
"enabled": true,
"metadata": {
"environment": "production",
"description": "Main webhook endpoint"
}
}
View webhook delivery history with retry attempts and response codes.
{
"deliveries": [
{
"id": "del_rs_123456",
"event_type": "payment.succeeded",
"status": "delivered",
"http_status": 200,
"attempts": 1,
"delivered_at": "2025-06-27T10:30:00Z",
"response_time": 245
},
{
"id": "del_rs_123457",
"event_type": "subscription.created",
"status": "failed",
"http_status": 500,
"attempts": 3,
"next_retry": "2025-06-27T11:00:00Z"
}
]
}
Send test webhook events to verify endpoint configuration and connectivity.
-
event_type
string
Type of test event to send
-
test_data
object
Custom test payload (optional)