PleasureStock API

Overview

The PleasureStock API provides programmatic access to our comprehensive adult products database, enabling seamless integration of inventory management and smart reordering capabilities into your systems.

Key Features

• Access to complete product catalog with adult toys and accessories
• Submit sales data for inventory tracking
• Get AI-powered smart reordering recommendations
• RESTful design with JSON responses
• Secure API key authentication

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

curl -H "X-API-Key: YOUR_API_KEY" \
  https://dev.pleasurestock.com/api/v1/products

Getting an API Key

1. Log in to your PleasureStock account as a company manager
2. Navigate to Settings → API Keys
3. Click "Generate New Key"
4. Give your key a descriptive name
5. Copy and securely store your API key

API Endpoints

{
  "sales": [
    {
      "internal_id": "pl_1234567890",
      "date": "2025-01-15",
      "quantity": 5,
      "stock_on_hand": 20  // optional
    }
  ]
}

{
  "success": true,
  "message": "Sales data processed successfully",
  "processed": 1,
  "errors": []
}

{
  "recommendations": [
    {
      "product": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "internal_id": "pl_1234567890",
        "name": "Premium Vibrator",
        "sku": "VIB-001"
      },
      "recommended_quantity": 45,
      "current_stock": 10,
      "average_daily_sales": 1.5,
      "forecast_accuracy": 92.3
    }
  ],
  "pagination": {
    "total": 25,
    "page": 1,
    "pages": 2,
    "limit": 20
  }
}

{
  "products": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "internal_id": "pl_1234567890",
      "name": "Premium Vibrator",
      "sku": "VIB-001",
      "category": "Vibrators",
      "price": 89.99,
      "currency": "EUR",
      "in_stock": true,
      "images": [
        "https://dev.pleasurestock.com/uploads/products/vib-001-1.jpg"
      ]
    }
  ],
  "pagination": {
    "total": 150,
    "page": 1,
    "pages": 8,
    "limit": 20
  }
}

Rate Limits

To ensure fair usage and system stability, the API enforces the following rate limits:

Rate limit information is included in response headers:

• X-RateLimit-Limit - Request limit per hour
• X-RateLimit-Remaining - Remaining requests
• X-RateLimit-Reset - Time when limit resets

Error Handling

The API uses standard HTTP status codes to indicate success or failure of requests.

Error Response Format

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The internal_id field is required",
    "details": {
      "field": "internal_id",
      "value": null
    }
  }
}

Code Examples

import requests
import json

# Your API key
api_key = "YOUR_API_KEY"
base_url = "https://dev.pleasurestock.com/api/v1"

# Headers
headers = {
    "X-API-Key": api_key,
    "Content-Type": "application/json"
}

# Submit sales data
sales_data = {
    "sales": [
        {
            "internal_id": "pl_1234567890",
            "date": "2025-01-15",
            "quantity": 5,
            "stock_on_hand": 20
        }
    ]
}

response = requests.post(
    f"{base_url}/sales",
    headers=headers,
    json=sales_data
)

print(response.json())

# Get smart reordering recommendations
response = requests.get(
    f"{base_url}/smart-reordering",
    headers=headers,
    params={"limit": 10}
)

recommendations = response.json()
for rec in recommendations["recommendations"]:
    print(f"Product: {rec['product']['name']}")
    print(f"Recommended quantity: {rec['recommended_quantity']}")
    print("---")

const axios = require('axios');

const API_KEY = 'YOUR_API_KEY';
const BASE_URL = 'https://dev.pleasurestock.com/api/v1';

// Configure axios instance
const api = axios.create({
  baseURL: BASE_URL,
  headers: {
    'X-API-Key': API_KEY,
    'Content-Type': 'application/json'
  }
});

// Submit sales data
async function submitSales() {
  try {
    const salesData = {
      sales: [
        {
          internal_id: 'pl_1234567890',
          date: '2025-01-15',
          quantity: 5,
          stock_on_hand: 20
        }
      ]
    };
    
    const response = await api.post('/sales', salesData);
    console.log('Sales submitted:', response.data);
  } catch (error) {
    console.error('Error:', error.response.data);
  }
}

// Get recommendations
async function getRecommendations() {
  try {
    const response = await api.get('/smart-reordering', {
      params: { limit: 10 }
    });
    
    response.data.recommendations.forEach(rec => {
      console.log(`Product: ${rec.product.name}`);
      console.log(`Recommended: ${rec.recommended_quantity}`);
      console.log('---');
    });
  } catch (error) {
    console.error('Error:', error.response.data);
  }
}

// Run examples
submitSales();
getRecommendations();

# Submit sales data
curl -X POST https://dev.pleasurestock.com/api/v1/sales \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sales": [{
      "internal_id": "pl_1234567890",
      "date": "2025-01-15",
      "quantity": 5,
      "stock_on_hand": 20
    }]
  }'

# Get smart reordering recommendations
curl -X GET "https://dev.pleasurestock.com/api/v1/smart-reordering?limit=10" \
  -H "X-API-Key: YOUR_API_KEY"

# Search products
curl -X GET "https://dev.pleasurestock.com/api/v1/products?search=vibrator&limit=5" \
  -H "X-API-Key: YOUR_API_KEY"