WebCommander API Introduction

Welcome to WebCommander!

Ready to streamline your online store? With our API, you can effortlessly manage product listings, customer orders, payments, inventory, and shipping. Explore this guide and start building a seamless shopping experience today!

Overview

What is an API?

APIs (Application Programming Interfaces) allow applications to work together by requesting features or data without needing to understand the other system's internal details.

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

Why Use APIs?

Seamless communication between frontend, backend, and third-party services.
Secure and efficient retrieval, updating, and management of product, customer, and order data.
Integration with payment gateways, shipping providers, and inventory management.
Support for multiple platforms, including web, mobile apps, and marketplaces.
Scalability, enabling services to function independently yet stay connected.
Automation of repetitive tasks such as order processing, notifications, and stock updates.
Improved security with authentication and authorization controls.
Real-time analytics and reporting for business insights.

Key Features

Products

Create Products: Add new products with complete details, including title, description, price, stock, categories, and images.
Update Products: Modify product information anytime.
Delete Products: Remove outdated products.
Manage Variants: Handle product attributes like size and color.
Inventory Tracking: Automate stock management.

Customers

Create Customers: Register new customers with essential details.
Update Customers: Modify customer profiles and preferences.
Delete Customers: Remove inactive or duplicate accounts.
Manage Orders: Track customer purchases and order status.
Customer Segmentation: Categorize customers based on behavior.

Orders

Create Orders: Process new purchases.
Update Orders: Modify order details before fulfillment.
Delete Orders: Cancel or remove unfulfilled orders.
Manage Order Status: Track order progress.
Order History & Tracking: Maintain records of past orders.

Shipping & Handling

Create Shipping Profiles: Define shipping rules and rates.
Update Shipping Rules: Modify delivery methods.
Delete Shipping Profiles: Remove outdated shipping settings.
Assign Shipping Zones: Categorize regions for different rates.

Tax & Currency

Create Tax Rules: Set up tax rates based on location.
Update Tax Rates: Adjust tax percentages.
Delete Tax Rules: Remove obsolete tax settings.

Pages

Create Pages: Design and publish custom pages.
Update Pages: Modify content, images, and SEO settings.
Delete Pages: Remove outdated pages.
Organize Sections: Manage page elements.

Blog & Articles

Create Blog Posts & Articles: Publish engaging content.
Update Blog Posts & Articles: Modify details anytime.
Delete Blog Posts & Articles: Remove outdated content.
Manage Comments: Moderate user interactions.
Organize Categories: Improve content discoverability.

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 without authentication.
Private APIs: Require authentication for secure access to sensitive data.

Response Codes

WebCommander API uses standard HTTP status codes for error handling.

Status Code	Status	Description
200	OK	The request was successful.
201	CREATED	The resource was successfully created.
202	ACCEPTED	Request accepted but not yet processed.
204	NO CONTENT	Request successful but no content to return.
400	BAD REQUEST	Invalid syntax in request.
401	UNAUTHORIZED	Authentication is required or has failed.
403	FORBIDDEN	The server refuses to authorize the request.
404	NOT FOUND	The requested resource could not be found.
405	METHOD NOT ALLOWED	The request method is not supported.
409	CONFLICT	The request conflicts with the server state.
413	FILE TOO LARGE	The request entity is too large.
422	UNPROCESSABLE ENTITY	The request cannot be processed.
429	TOO MANY REQUESTS	Rate limit exceeded.
500	INTERNAL SERVER ERROR	An unexpected error occurred.
502	GATEWAY TIMEOUT	The server did not respond in time.

Each error response includes an error code and a descriptive message to help diagnose issues effectively.