JoomShopping REST API

A full REST API addon for JoomShopping that lets you manage your store programmatically via HTTP requests. Supports 40+ endpoints covering the entire store — catalog, orders, shipping, payments, configuration, and users.

All responses are in JSON:API format. Authentication uses the standard Joomla API Token (Bearer).

---

Authentication

Generate a Joomla API Token and include it in every request:

Authorization: Bearer YOUR_API_TOKEN

How to get your token:

1. Go to Joomla Administrator panel
2. Open Users → Manage
3. Select a user and open the API Token tab
4. Click Generate Token and copy it

More details: Joomla Core APIs

---

Base URL

/api/index.php/v1/shop/{resource}

---

Supported Operations

Every resource supports the full set of CRUD operations:

Method	Description
GET /shop/{resource}	List all items
GET /shop/{resource}/{id}	Get a single item
POST /shop/{resource}	Create a new item
PATCH /shop/{resource}/{id}	Update an item
DELETE /shop/{resource}/{id}	Delete an item

---

Available Endpoints

Catalog

Resource	Description
products	Products
categories	Categories
manufacturers	Manufacturers
productlabels	Product labels
productimages	Product images
productsvideos	Product videos
productsfiles	Product files

Attributes

Resource	Description
attributes	Attributes
attributesgroups	Attribute groups
attributesvalues	Attribute values
freeattributes	Free attributes
productsattrs	Product attributes
productsattr2s	Product attributes (type 2)

Product Extras

Resource	Description
productfields	Product fields
productfieldvalues	Product field values
productsoptions	Product options
productsprices	Product prices
productsrelations	Related products

Orders

Resource	Description
orders	Orders
orderitems	Order items
orderhistorys	Order history
orderstatus	Order statuses

Payments

Resource	Description
payments	Payment methods
paymenttrxs	Payment transactions
paymenttrxdatas	Payment transaction data

Shipping

Resource	Description
shippings	Shipping methods
shippingsprices	Shipping prices
shippingmethodpricecountries	Shipping prices by country
shippingmethodpriceweights	Shipping prices by weight
deliverytimes	Delivery times

Store Settings

Resource	Description
currencies	Currencies
countries	Countries
taxs	Taxes
exttaxes	Extended taxes
units	Units of measure
coupons	Coupons
languages	Languages
addons	Installed addons

Configuration

Resource	Description
configs	General configuration
configseos	SEO configuration
configstatictexts	Static texts
importexports	Import/Export settings

Users

Resource	Description
users	Users
usergroups	User groups
vendors	Vendors
reviews	Product reviews

---

HTTP Status Codes

Code	Meaning
200	OK
204	Deleted successfully
400	Validation error
401	Unauthorized
404	Not found

---

Example Requests

List products:

GET /api/index.php/v1/shop/products
Authorization: Bearer YOUR_API_TOKEN

Get a single order:

GET /api/index.php/v1/shop/orders/42
Authorization: Bearer YOUR_API_TOKEN

Create a category:

POST /api/index.php/v1/shop/categories
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

{
  "name": "Electronics",
  "category_parent_id": 0,
  "category_publish": 1,
  "ordering": 1
}

Update a product:

PATCH /api/index.php/v1/shop/products/15
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

{
  "name": "Updated Product Name",
  "product_price": 27999.00,
  "product_publish": 1
}

Delete a product:

DELETE /api/index.php/v1/shop/products/15
Authorization: Bearer YOUR_API_TOKEN

---

Documentation

Full addon documentation: https://www.webdesigner-profi.de/joomla-webdesign/example/addon_api_web_service.html

JoomShopping downloads: https://www.webdesigner-profi.de/joomla-webdesign/joomla-shop/downloads.html

---

License

See LICENSE.