RESTful API v1¶
The eSales Enterprise Web API Service is a RESTful web service that handles the communication with the Apptus eSales Cluster. Load balancing and failover are both handled automatically.
If any connection problems are encountered using the Apptus eSales Web API, verify that the client that is used is following the Connection requirements.
API key and credentials¶
To be able to access and use the eSales API, the customer onboarding Prerequirements must be fulfilled.
The standard base URL for the Apptus eSales Web API is
All responses that are applicable from eSales will be compressed with gzip if the header
Accept-Encoding has the value
gzip. Imports and dynamic page requests can have their request bodies compressed with gzip if the header
Content-Encoding has the value
gzip. It is recommended that the imports are compressed.
All API endpoints have different required parameters. All required parameters are to be considered as case sensitive. It is recommended to set a user-agent request header in all client requests to the RESTful API.
- Panel Query
- Dynamic Page
- Click Notification
- Non-eSales Click Notification
- Adding to Cart Notification
- Non-eSales Adding to Cart Notification
- Add Favourite Notification NEW
- Remove Favourite Notification NEW
- Payment Notification
- Secure Payment Notification
- End Notification
Try out the API at the Apptus API Playground with your eSales Playground and API credentials.