xclade Commerce API

Overview

The xclade Commerce API provides a comprehensive set of RESTful endpoints designed for enterprise SaaS applications. Built on a multi-tenant architecture, each tenant receives a dedicated API endpoint ensuring data isolation, performance optimization, and scalability.

This API enables you to build sophisticated commerce experiences with capabilities including:

• Product catalog management and search
• Shopping cart and checkout workflows
• Order processing and fulfillment
• Customer authentication and profile management
• Payment processing and reconciliation
• Multi-currency and multi-region support
• Returns and refund management

Base URL Structure

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

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

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

Authentication

The API implements industry-standard authentication mechanisms to ensure secure access:

JWT Token Authentication Bearer token-based authentication for API requests. Include the token in the Authorization header:

Authorization: Bearer {your-jwt-token}

Session-Based Authentication Cookie-based session management for web applications. Session cookies are automatically managed by the client.

Password Reset Token Temporary bearer tokens issued for secure password reset workflows.

API Architecture

The API is organized into logical resource groups, each handling specific business domains:

Core Resources

• Auth: Authentication, session management, and token refresh
• Customers: Customer accounts, profiles, and address management

Commerce Resources

• Products: Product catalog, variants, and inventory
• Collections: Curated product groupings
• Product Categories: Hierarchical product organization
• Carts: Shopping cart lifecycle and line item management
• Orders: Order placement, tracking, and history

Payment & Fulfillment

• Payment Collections: Payment session orchestration
• Payment Providers: Available payment method configuration
• Shipping Options: Delivery method selection and calculation

Supporting Resources

• Regions: Geographic market configuration
• Currencies: Multi-currency pricing support
• Returns: Return request processing
• Gift Cards: Gift card issuance and redemption
• Store Credit: Customer credit balance management

Getting Started

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

• Detailed parameter specifications
• Request and response schemas
• Code examples in multiple programming languages
• Authentication requirements
• Error response formats

Rate Limiting

API requests are subject to rate limiting to ensure service stability. Rate limit information is included in response headers. Contact support for enterprise rate limit configurations.

Support

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