html web site design software

Connect to PepperShop

Get started with the PepperShop Webservice API


Just working in the way you like it!

REST based

It's just how you expect it to be.

If you have already worked with APIs you could be already familiar with the way our API is working. 


JavaScript Object Notation

To keep things simple on all platforms and programming languages, our API provides all the data in JSON format.
It's even compliant with JSON.API.

Easy to use

Starting is easy

Our API even helps you making calls: In many cases you'll get a hint with helpful tips.


Basic Authentication

Data will be sent via an encrypted connection, but as easy as basic authentication works.

Getting Started

You're only 3 Steps from Coding


Install Webservice API module in your PepperShop (v6+ Enterprise):

Module > "Webservice API" > Installieren > Benutzen

Don't have a PepperShop yet? Get a PepperShop!


Activate and add new user. Save changes.


Add HTTP Header to your Request:

Authorization: Basic eW91cnVzZXJuYW1lOnlvdXJhcGlrZXk=


Read the online documentation for detailed information:


Version 2.0

  • New Endpoints: pictures, unit_codes, hooks, vouchers
  • Multilanguage support (product/category/units: names, description, ...)
  • POST with update-if-exists functionality
  • Optimizations for default values
  • Various bugfixes and optimizations

Version 0.9 -1.0

  • Various Bugfixes
  • Multi stock functionality
  • New filter on orders: state

Version 0.2

  • Collections have now includes (e. g. orders come with customer included)
  • Customers can be accessed and updated by 'internal_id', if IDs not yet set by external ERP
  • New 'order' fields: language, is_pickup
  • New calls 'product_documents', 'property_definition', 'product_property'
  • New docs design


Version 0.1

  • English interface


Frequently asked questions

API says "API OFF", how can I activate it?

In the Shop-Administration, move to "Module". Go to "Modulverwaltung" and check, whether "Webservice API" is listed on the right under "Bereits installierte Module".

When installed, mark it and click "Benutzen". 

Activate the checkbox on the top, add a new user and click "Speichern".

You're ready to start making calls!

Can I display API responses in browser?

Yes. If you call the API from your browser the first time, a window pops up, where you can enter username and password.

You can also display the response formatted in a human readable style by adding ?pretty=true to your request.

To test your calls comfortably, we recommend Postman, a free tool to make HTTP requests. It can even generate some basic request code for you!


Want more  information about the PepperShop?