Unlimited Flexibility

Shoporama’s REST API gives you full access to your online store’s data. You can retrieve, create, update, and delete everything from products and orders to customers and categories. This enables integrations with exactly the systems you need.

What can you do with the API?

Here are just a few of the things Shoporama’s REST API supports:

• Products: Create, update, retrieve, and delete products with all fields, including variants, images, prices, and inventory. Deleted products can be restored from the trash
• Orders: Retrieve orders, update status, create shipping labels, and download them directly via the API. Change the status of up to 25 orders at a time with a preview of what the change will trigger, and retrieve the picking list and returns
• Inventory: Move items between warehouse locations, retrieve inventory transactions, and update inventory value based on cost prices
• Statistics: the same reports as under “Statistics” in the admin panel, such as sales, profit margin, bestsellers, inventory, marketing, and customers, with comparisons to the previous period or last year
• Customers: Manage customer data, create new customers, and retrieve purchase history
• Categories: Create and manage your category hierarchy
• Brands and Manufacturers: Manage brands and manufacturers programmatically
• Pages and Blog: Create and update content pages and blog posts
• Vouchers: Create and manage discount codes
• Shipping: Retrieve shipping methods, set shipping rates by country and weight, and create shipping labels
• Online Store Settings: View and edit selected settings for the catalog, checkout, inventory, order emails, and SEO
• Landing pages: Manage landing pages and their content
• Newsletters: Manage newsletter lists, subscribers, and campaigns
• Webhooks: Receive real-time notifications when something happens in your store

OAuth Support

In addition to API keys, Shoporama also supports OAuth, allowing third-party applications to securely access your store without sharing your API key. The connection is tied to the user who authorizes it. If the user has been assigned a restricted role, such as Employee or Marketing, the app can only perform the actions permitted by that role.

Headless Commerce

With the REST API, you can build a completely custom frontend—a so-called headless solution. Use React, Vue, Next.js, or whatever frontend you prefer, and let Shoporama handle products, orders, and payments in the background.

Real-world examples

Shoporama’s REST API is used by online stores to:

• Integrate with ERP and financial systems
• Build their own warehouse apps for picking and shipping
• Synchronize prices and inventory status from external systems
• Integrate with POS systems in brick-and-mortar stores
• Generate advanced statistics and reports
• Build integrations with laboratories and analytics tools

Webhooks for real-time events

With webhooks, you can receive real-time notifications when something happens in your store—for example, when a new order is created, a product is updated, or a customer signs up. This makes your integrations faster and more efficient than polling.

Documentation and API Key

The API is fully documented with all endpoints, fields, and examples. You can create and find your API keys in the admin panel under Integrations → API Access and get started in just a few minutes. See Find or Create an API Key and REST API Documentation.

The API Access page can be accessed by users with the Full Access or Developer role. A key created by a user with the Developer role is limited to the capabilities of that role; therefore, a key for, say, an order integration must be created by a user with Full Access. Read more in Roles and Permissions.