Introduction
A comprehensive API documentation for the Remarkable Commerce platform
Welcome to the Remarkable Commerce API
The Remarkable Commerce API provides a powerful set of tools for integrating with and extending your eCommerce platform. Below is a categorized list of API namespaces, each with its own features and functionality.
Auth
Manage secure access to the platform by generating JWT tokens for authentication.
Batches
Handle batch operations for customers, orders, products, and stock management with bulk processing capabilities.
Customers
Manage customer data, including creating accounts, updating addresses, password management, and retrieving customer orders.
Enquiries
Submit and manage customer enquiries, including reward card requests and other customer service interactions.
Fashion Cheque
Integrate Fashion Cheque payment services for card creation, redemption, and transaction management.
Orders
Create and manage customer orders, including updating addresses, adding payments, shipping options, and checking order validity.
Products
Access comprehensive product information including details, prices, images, stock levels, and delivery options.
Settings
Retrieve platform configuration settings such as countries, currencies, payment providers, and system redirects.
API Overview
The Remarkable Commerce API is organized into logical namespaces:
- Auth: Authentication and token management
- Batches: Bulk operations for data processing
- Customers: Complete customer lifecycle management
- Enquiries: Customer service and support requests
- Fashion Cheque: Specialized payment integration
- Orders: Order processing and management
- Products: Product catalog and inventory
- Settings: System configuration and settings
Getting Started
Navigate through the API namespaces on the left to explore detailed documentation for each endpoint. Each section contains methods, parameters, examples, and responses to help you integrate the Remarkable Commerce API seamlessly into your application.
For authentication requirements and rate limiting information, please refer to the getting started guide.
How is this guide?
Last updated on