REST API (Headless)

Shoporama's REST API allows you to integrate your online store with external systems such as inventory management, accounting, PIM systems and other apps. The API supports full CRUD functionality on products, orders, customers, categories and more.

Create an API key

1. Go to Settings → API in the administration
2. Click Add access
3. Give the key a name (e.g. "Inventory" or "Accounting")
4. Select access level: All (read/write), Read only or Write only
5. Optionally set a daily limit for the number of API calls
6. Save - your API key is now displayed

How to use the API

All calls are sent to /REST/ with your API key in the header:

Authorization: your-api-key

Data is sent and received as JSON with Content-Type: application/json.

Available endpoints

The API covers all important parts of your online store:

• Products - Create, update, retrieve and delete products with images, variants and stock status
• Categories - Manage your category structure
• Orders - Retrieve orders, update status, generate shipping labels and handle returns
• Customers - Manage customer profiles and customer fields
• Inventory - Update inventory, including per variant and per location
• Batches - Create and manage batches with expiration dates
• Newsletter - Manage subscribers, lists and campaigns
• Content - Blog, pages, menus, redirects and landing pages
• Brands and suppliers - Manage brands, manufacturers and suppliers
• Shipping and payment - Get shipping methods and payment gateways
• Webhooks - Receive notifications when orders, products or stock changes

Webhooks

With webhooks, you can receive automatic notifications when changes occur in your online store. You create webhooks via the API and specify a URL that Shoporama calls when an event occurs. Supported events:

• order - When an order is created or changes status
• stock - When the stock level changes
• product - When a product is created or updated

Supporting documentation

The full API documentation with all endpoints, parameters and examples can be found in the Swagger documentation under Settings → API → Documentation in the administration. Here you can also test calls directly in the browser.

Usage overview

Under each API key, you can see a log of all calls with time, endpoint and HTTP method. You can also export the log as a CSV file.