xclade Admin API

Overview

The xclade Admin API provides powerful administrative endpoints for managing your commerce platform. This API is designed for backend systems, administrative dashboards, and internal tools that require elevated permissions and comprehensive control over your commerce operations.

Key capabilities include:

• Complete product catalog management
• Order management and fulfillment workflows
• Customer data administration
• Inventory and pricing control
• Payment and shipping configuration
• Analytics and reporting data access
• Multi-tenant administration

Base URL Structure

Each tenant in the xclade platform is assigned a unique admin API endpoint:

https://{your-tenant}.api.myxclade.com/admin

Replace {your-tenant} with your organization's tenant identifier. You can find your tenant identifier in the xclade dashboard at xclade.com.

Authentication

The Admin API requires authentication with elevated privileges:

JWT Token Authentication Admin API requests must include a valid bearer token with admin-level permissions:

Authorization: Bearer {your-admin-jwt-token}

API Keys For server-to-server integrations, use API keys configured in your admin dashboard:

x-api-key: {your-api-key}

Session-Based Authentication Cookie-based session management for admin web applications.

API Architecture

The Admin API provides comprehensive management capabilities across all business domains:

Product Management

• Products: Full product lifecycle management
• Collections: Collection creation and management
• Categories: Hierarchical category administration
• Inventory: Stock level management and tracking

Order Management

• Orders: Order processing, fulfillment, and tracking
• Shipments: Shipping management and tracking
• Returns: Return authorization and processing
• Refunds: Payment refund processing

Customer Management

• Customers: Customer account administration
• Customer Groups: Segment and group management
• Addresses: Customer address management

Commerce Configuration

• Regions: Market and region configuration
• Currencies: Currency support management
• Tax Rates: Tax configuration and rules
• Shipping Options: Delivery method configuration
• Payment Providers: Payment gateway configuration

Store Management

• Sales Channels: Multi-channel commerce setup
• Store Settings: Platform configuration
• User Management: Admin user and role management

Getting Started

Navigate through the Admin API sections using the sidebar menu. Each endpoint provides:

• Comprehensive parameter documentation
• Request and response schemas
• Authentication and authorization requirements
• Code examples in multiple languages
• Error handling guidance

Rate Limiting

Admin API requests are subject to higher rate limits than store API. Rate limit information is included in response headers. Contact support for enterprise configurations.

Security Best Practices

• Never expose admin API credentials in client-side code
• Use API keys for server-to-server integrations
• Implement proper access control and audit logging
• Rotate API keys regularly
• Monitor API usage for unusual patterns

Support

For technical assistance, integration guidance, or to report issues, please visit xclade.com or contact your account representative.