Web Services — REST API addon for JoomShopping
Important: This is an
alpha version of the addon and is intended
for testing purposes only.
It may contain bugs, incomplete features, or breaking changes. Not recommended for production use.
Provides a full REST API to manage your JoomShopping store programmatically via HTTP requests.
Uses Joomla API Token (Bearer) for authentication. All responses are in JSON:API format.
Supported operations for all resources:
GET (list & single item) • POST • PATCH • DELETE
Available endpoints (40+):
- Catalog: products, categories, manufacturers, productlabels, productimages, productsvideos, productsfiles
- Attributes: attributes, attributesgroups, attributesvalues, freeattributes, productsattrs, productsattr2s
- Product extras: productfields, productfieldvalues, productsoptions, productsprices, productsrelations
- Orders: orders, orderitems, orderhistorys, orderstatus
- Payments: payments, paymenttrxs, paymenttrxdatas
- Shipping: shippings, shippingsprices, shippingmethodpricecountries, shippingmethodpriceweights, deliverytimes
- Store settings: currencies, countries, taxs, exttaxes, units, coupons, languages, addons
- Configuration: configs, configseos, configstatictexts, importexports
- Users: users, usergroups, vendors, reviews
Base URL: /api/index.php/v1/shop/{resource}
HTTP status codes:
- 200 — OK
- 204 — Deleted successfully
- 400 — Validation error
- 401 — Unauthorized
- 404 — Not found
Documentation
Authentication (Joomla API Token):
To use the API, you need to generate a Joomla API Token and include it in the Authorization header:
Authorization: Bearer YOUR_API_TOKEN
How to get API Token:
- Go to Joomla Administrator panel
- Open Users → Manage
- Select a user
- Open the API Token tab
- Click Generate Token
- Copy and use it in your API requests
More details: https://docs.joomla.org/J4.x:Joomla_Core_APIs