- Menu
- Sitemap
Reference - WebShop REST API 7.6
1 Introduction
This reference lists the REST API for storefront development. The REST API covers features of both, the B2C (=SMB - Small and Medium-sized businesses) and the B2B storefront development. This reference is intended for developers who want to make use of an easy-to-use API when developing frontend solutions.
2 Rest API
This section describes all available REST API calls for the respective version of the Intershop software.
| Title | Http Method | Short Description | Product Version | Page Type | Product To Version |
|---|---|---|---|---|---|
| REST API - Get productlist by global search | GET | Get list of items by global product search | 7.4 | RefSnippet | |
| REST API - Returns product notifications SMB | GET | Returns two links to the stock and price resources | 7.4 | RefSnippet |
|
| REST API - Add a payment to Customer profile | POST | Adds a payment method to the customer profile | 7.5.1 | RefSnippet |
|
| REST API - Add new product review | POST | Add new product review | 7.4 | RefSnippet |
|
| REST API - Add Payment to basket (until 7.4 CI) | POST | Adds a payment method to the basket | 7.4 | RefSnippet | 7.4.6 |
| REST API - Add payment to basket (until 7.8) | POST | Adds a payment method to the basket | 7.6 | RefSnippet | 7.8 |
| REST API - Cancel order (until 7.8) | PUT | Cancel an Order | 7.4 | RefSnippet | 7.8 |
| REST API - CAPTCHA Challenge | GET | Responds with script snippet containing CAPTCHA challenge | 7.5 | RefSnippet |
|
| REST API - Company profile details (until 7.8) | GET | Returns a response containing company profile information. | 7.4 | RefSnippet | 7.8 |
| REST API - Create a new basket (until 7.8) | POST | Creates a new basket. | 7.4 | RefSnippet | 7.8 |
| REST API - Create new business customer wish list | POST | Creates a new customer wish list by using POST data provided by the client | 7.4 | RefSnippet | |
| REST API - Create new customer address (until 7.7) | POST | Creates a new customer address by using POST data provided by the client | 7.5.1 | RefSnippet | 7.7 |
| REST API - Create new order (valid until 7.4 CI) | POST | Creates/submits an order | 7.4 | RefSnippet | 7.4.6 |
| REST API - Create new private customer wish list | POST | Creates a new customer wish list | 7.4 | RefSnippet | |
| REST API - Create private customer (until 7.7) | POST | Creates a private customer | 7.4 | RefSnippet | 7.7 |
| REST API - Create product price notification B2C | POST | Creates product price notification | 7.4 | RefSnippet | |
| REST API - Create product price notification SMB | POST | Creates product price notification | 7.4 | RefSnippet |
|
| REST API - Create product stock notification B2C | POST | Creates product stock notification | 7.4 | RefSnippet |
|
| REST API - Create product stock notification SMB | POST | Creates product stock notification | 7.4 | RefSnippet |
|
| REST API - Create Recommendation context | POST | Creates a new recommendation context | 7.5 | RefSnippet |
|
| REST API - Customer addresses list (until 7.7) | GET | Returns a list of links to customer addresses resources. | 7.4 | RefSnippet | 7.7 |
| REST API - Delete basket sub line item (until 7.8) | DELETE | Delete the sublinetype of a specific basket item | 7.4 | RefSnippet | 7.8 |
| REST API - Delete business customer wish list | DELETE | Delete a customer wish list | 7.4 | RefSnippet | |
| REST API - Delete customer address (until 7.7) | DELETE | Delete a customer address. | 7.4 | RefSnippet | 7.7 |
| REST API - Delete item from basket by its ID (until 7.8) | DELETE | Removes the specified line item from basket. | 6.6 | RefSnippet | 7.8 |
| REST API - Delete private customer wish list | DELETE | Delete a customer wish list | 7.4 | RefSnippet | |
| REST API - Delete product price notification B2C | DELETE | Deletes a product price notification | 7.4 | RefSnippet | |
| REST API - Delete product price notification SMB | DELETE | Deletes product price notification | 7.4 | RefSnippet | |
| REST API - Delete product review by id | DELETE | Deletes a product review by its ID | 7.4 | RefSnippet |
|
| REST API - Delete product stock notification B2C | DELETE | Deletes a product stock notification | 7.4 | RefSnippet | |
| REST API - Delete product stock notification SMB | DELETE | Deletes product stock notification | 7.4 | RefSnippet | |
| REST API - Get a list of active baskets (until 7.8) | GET | Gets all open baskets for the current user. | 7.4 | RefSnippet | 7.8 |
| REST API - Get address' list of links to suggested addresses (until 7.7) | GET | Retrieves and returns a list of resources' links that a client could access to view suggested addresses details | 7.4 | RefSnippet | 7.7 |
| REST API - Get all line items of the basket (until 7.8) | GET | Gets all line items contained in the given basket. | 7.4 | RefSnippet | 7.8 |
| REST API - Get basket by ID (until 7.4 CI) | GET | Returns the basket's summary. | 7.4 | RefSnippet | 7.4.6 |
| REST API - Get basket by ID (until 7.7) | GET | Returns the basket's summary. | 7.5 | RefSnippet | 7.7 |
| REST API - Get basket item by ID (until 7.8) | GET | Get the specified line item from basket. | 7.4 | RefSnippet | 7.8 |
| REST API - Get basket sub line item by type (until 7.8) | GET | Get the sub-line type of a specific basket item. | 7.4 | RefSnippet | 7.8 |
| REST API - Get business customer wish list details | GET | Retrieves and returns details about customer's wish list to the client | 7.5 | RefSnippet | |
| REST API - Get business customer wish list details (until 7.4 CI) | GET | Retrieves and returns details about customer's wish list to the client. | 7.4 | RefSnippet | 7.4.6 |
| REST API - Get category links by link type and target objects (products or categories) | GET | Retrieves a list of products and a list of categories linked by the given category and filtered by the provided link type/target object | 7.4 | RefSnippet |
|
| REST API - Get customer contract details | GET | Get detailed information about the contract with the given contractUUID | 7.6 | RefSnippet | |
| REST API - Get customer contract orders | GET | Get all orders related to the contract with the given contractUUID | 7.6 | RefSnippet | |
| REST API - Get customer contracts | GET | Gets all contracts of a customer | 7.6 | RefSnippet | |
| REST API - Get details of a customer profile payment (until 7.9) | GET | Returns the details of a payment method from the customer profile | 7.4 | RefSnippet | 7.9 |
| REST API - Get info on (sub-)category (until 7.8) | GET | Get info about (sub-) category. | 7.4 | RefSnippet | 7.8 |
| REST API - Get list of bundles for product bundle (until 7.8) | GET | Equivalent to /categories/<cat_ID>/products/<sku>/bundles but without categories See REST API - Get list of bundles for product bundle in category (until 7.8) | 7.4 | RefSnippet | 7.8 |
| REST API - Get list of bundles for product bundle in category (until 7.8) | GET | Get list of bundles for product bundle | 7.4 | RefSnippet | 7.8 |
| REST API - Get list of Customer profile payments | GET | Returns a list of payment methods of the customer profile | 7.4 | RefSnippet |
|
| REST API - Get list of products (until 7.8) | GET | Equivalent to /categories/<catID>/products?amount=<amount>&offset=<offset> but without categories | 7.4 | RefSnippet | 7.8 |
Disclaimer
The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.