WebCommander API Introduction

Introduction

Welcome to the WebCommander API! Ready to simplify and automate your eCommerce operations? With our API, you can seamlessly manage product listings, categories, variations, pricing, orders, customers, discounts, shipping, and much more. Whether you’re integrating with third-party systems or building your own storefront, WebCommander’s API empowers developers to create dynamic, scalable, and fully customized shopping experiences.

Overview

Let’s know about APIs first!

APIs (Application Programming Interfaces) allow different systems to communicate and share data efficiently. They help your applications perform complex operations such as retrieving product data, processing orders, or updating inventory without needing to understand the inner workings of WebCommander.

The WebCommander API is built on REST principles, using standard HTTP methods such as GET, POST, PUT, PATCH, and DELETE . All API requests are made to the WebCommander base URL, and responses are returned in JSON format.

Why do we need APIs?

To connect online stores with third-party platforms (CRMs, POS systems, or shipping gateways).
To automate store operations such as inventory updates and order fulfillment.
To integrate payment and tax management services easily.
To ensure secure and structured communication between backend systems and storefronts.
To speed up development by reusing existing WebCommander services and data.
To provide real-time data exchange and improved operational efficiency.

Key Features

Products

Create Products: Add products with details like title, description, SKU, price, stock, and images.
Update Products: Modify product attributes anytime.
Delete Products: Remove products that are discontinued or inactive.
Manage Variations: Handle size, color, and other product variations.
Inventory Management: Track and update product stock levels automatically.

Carts

Manage Shopping Carts: Create, update, and delete cart sessions for users.
Add or Remove Products: Dynamically update cart contents in real-time.
Calculate Totals: Automatically compute taxes, discounts, and shipping costs

Variations

Create Variations: Define product attributes like color, size, and material.
Update Variations: Edit existing attributes as product lines evolve.
Delete Variations: Remove unnecessary or merged product options.

Currency & Tax

Manage Currencies: Configure multiple currencies for international selling.
Create Tax Rules: Define tax rates and rules based on country or region.
Update Tax Settings: Adjust inclusivity/exclusivity and percentage values.
Delete Tax Rules: Remove outdated tax configurations.

Discounts

Create Discounts: Offer promotional codes or automatic discounts on orders.
Update Discounts: Adjust discount values or validity dates.
Delete Discounts: Remove expired or inactive offers.
Apply Discount Rules: Manage conditional discounts like minimum spend or specific categories.

Shipping

Create Shipping Methods: Define delivery options, rates, and regions.
Update Shipping Profiles: Modify existing shipping zones or rate tiers.
Delete Shipping Rules: Remove obsolete shipping configurations.
Integrate Shipping Providers: Connect with external carriers and delivery services.

Customers

Create Customers: Register new customers with contact and billing information.
Update Customer Profiles: Modify details like address, preferences, or password.
Delete Customers: Remove inactive or duplicate customer accounts.
View Customer Orders: Access purchase history and order activity.

Orders

Create Orders: Place new orders programmatically.
Update Orders: Modify shipping info, billing details, or order status.
Cancel Orders: Safely handle order cancellations and refunds.
Track Orders: Retrieve real-time order status and fulfillment updates.

Blog & Articles

Create Blog Posts: Publish engaging articles or announcements.
Update Blog Content: Edit existing posts and metadata.
Delete Blog Posts: Remove outdated articles.
Manage Comments & Categories: Moderate interactions and organize posts.

Settings

Configure Store Settings: Manage general configurations like store name, email, and timezone.
Payment Integrations: Connect with payment gateways such as Stripe or PayPal.
SEO & Analytics: Optimize store visibility and track performance metrics.
Security Settings: Control access permissions, roles, and API authentication.

Base URL

All API requests should be sent to the following base URL:

INSTANCE_URL/api/v3/admin/

Public & Private APIs

Public APIs: Provide general information such as product listings or blogs without requiring authentication.
Private APIs: Require authentication for secure access to sensitive data such as orders, payments, and customer information.

Response Codes

WebCommander API uses standard HTTP status codes for error handling.

Status Code	Status	Description
200	OK	The request was successful, and the server returned the requested data.
201	CREATED	The resource was successfully created.
202	ACCEPTED	The request has been accepted but is not yet processed.
204	NO CONTENT	The request was successful, but no content is returned.
400	BAD REQUEST	Invalid syntax or missing parameters in the request.
401	UNAUTHORIZED	Authentication failed or was not provided.
403	FORBIDDEN	The request is understood but not authorized.
404	NOT FOUND	The requested resource does not exist.
405	METHOD NOT ALLOWED	The request method is not supported for this resource.
409	CONFLICT	The request conflicts with the current server state.
413	FILE TOO LARGE	The uploaded file exceeds the size limit.
422	UNPROCESSABLE ENTITY	The server understands the request but cannot process it.
429	TOO MANY REQUESTS	The request limit has been exceeded.
500	INTERNAL SERVER ERROR	A server-side error occurred.
502	GATEWAY TIMEOUT	The server failed to get a timely response from another service.

Next Steps

To get started with the WebCommander API:

Authenticate Your Account: Review the Authentication section to generate and use your API token.
Explore Available Endpoints: Review API endpoints by module to perform CRUD operations.
Start Integration: Use the examples provided in this documentation to begin automating your WebCommander store.