- Menu
- Sitemap
Reference - WebShop REST API 7.6
https://support.intershop.com/kb/2L7707
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.
| Method | Title | Description | Valid From |
|---|---|---|---|
GET | REST API - Get productlist by global search | Get list of items by global product search | 7.4 |
GET | REST API - Returns product notifications SMB | Returns two links to the stock and price resources | 7.4 |
POST | REST API - Add a payment to Customer profile | Adds a payment method to the customer profile | 7.5.1 |
POST | REST API - Add new product review | Add new product review | 7.4 |
| POST | REST API - Add payment to basket (until 7.8) | Adds a payment method to the basket | 7.6 |
| POST | REST API - Add to Cart (valid from 7.4 to 7.6) | Adds a list of items to an existing cart. | 7.4 |
| PUT | REST API - Cancel order (until 7.8) | Cancel an Order | 7.4 |
GET | REST API - CAPTCHA Challenge | Responds with script snippet containing CAPTCHA challenge | 7.5 |
| GET | REST API - Company profile details (until 7.8) | Returns a response containing company profile information. | 7.4 |
| POST | REST API - Create a new basket (until 7.8) | Creates a new basket. | 7.4 |
POST | REST API - Create new business customer wish list | Creates a new customer wish list by using POST data provided by the client | 7.4 |
| POST | REST API - Create new customer address (until 7.7) | Creates a new customer address by using POST data provided by the client | 7.5.1 |
| POST | REST API - Create new order (until 7.6) | Creates/submits an order | 7.5 |
POST | REST API - Create new private customer wish list | Creates a new customer wish list | 7.4 |
| POST | REST API - Create private customer (until 7.7) | Creates a private customer | 7.4 |
| POST | REST API - Create product price notification B2C | Creates product price notification | 7.4 |
| POST | REST API - Create product price notification SMB | Creates product price notification | 7.4 |
POST | REST API - Create product stock notification B2C | Creates product stock notification | 7.4 |
POST | REST API - Create product stock notification SMB | Creates product stock notification | 7.4 |
| POST | REST API - Create Recommendation context | Creates a new recommendation context | 7.5 |
| GET | REST API - Customer addresses list (until 7.7) | Returns a list of links to customer addresses resources. | 7.4 |
| DELETE | REST API - Delete basket sub line item (until 7.8) | Delete the sublinetype of a specific basket item | 7.4 |
DELETE | REST API - Delete business customer wish list | Delete a customer wish list | 7.4 |
| DELETE | REST API - Delete customer address (until 7.7) | Delete a customer address. | 7.4 |
| DELETE | REST API - Delete item from basket by its ID (until 7.8) | Removes the specified line item from basket. | 6.6 |
DELETE | REST API - Delete private customer wish list | Delete a customer wish list | 7.4 |
DELETE | REST API - Delete product price notification B2C | Deletes a product price notification | 7.4 |
| DELETE | REST API - Delete product price notification SMB | Deletes product price notification | 7.4 |
| DELETE | REST API - Delete product review by id | Deletes a product review by its ID | 7.4 |
DELETE | REST API - Delete product stock notification B2C | Deletes a product stock notification | 7.4 |
DELETE | REST API - Delete product stock notification SMB | Deletes product stock notification | 7.4 |
| GET | REST API - Get a list of active baskets (until 7.8) | Gets all open baskets for the current user. | 7.4 |
| GET | REST API - Get address' list of links to suggested addresses (until 7.7) | Retrieves and returns a list of resources' links that a client could access to view suggested addresses details | 7.4 |
| GET | REST API - Get all line items of the basket (until 7.8) | Gets all line items contained in the given basket. | 7.4 |
| GET | REST API - Get basket by ID (until 7.7) | Returns the basket's summary. | 7.5 |
| GET | REST API - Get basket item by ID (until 7.8) | Get the specified line item from basket. | 7.4 |
| GET | REST API - Get basket sub line item by type (until 7.8) | Get the sub-line type of a specific basket item. | 7.4 |
GET | REST API - Get business customer wish list details | Retrieves and returns details about customer's wish list to the client | 7.5 |
GET | REST API - Get category links by link type and target objects (products or categories) | 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 |
GET | REST API - Get customer address details (until 7.6) | Retrieves and returns details about customer's address to the client. | 7.4 |
GET | REST API - Get customer contract details | Get detailed information about the contract with the given contractUUID | 7.6 |
GET | REST API - Get customer contract orders | Get all orders related to the contract with the given contractUUID | 7.6 |
GET | REST API - Get customer contracts | Gets all contracts of a customer | 7.6 |
GET | REST API - Get details of a customer profile payment (until 7.9) | Returns the details of a payment method from the customer profile | 7.4 |
| GET | REST API - Get info on (sub-)category (until 7.8) | Get info about (sub-) category. | 7.4 |
GET | REST API - Get list of bundles for product bundle (until 7.8) | 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 |
| GET | REST API - Get list of bundles for product bundle in category (until 7.8) | Get list of bundles for product bundle | 7.4 |
| GET | REST API - Get list of Customer profile payments | Returns a list of payment methods of the customer profile | 7.4 |
GET | REST API - Get list of products (until 7.8) | Equivalent to /categories/<catID>/products?amount=<amount>&offset=<offset> but without categories See REST API - Get list of products category (until 7.8) | 7.4 |
| GET | REST API - Get list of products assigned to a retail set (until 7.8) | Equivalent to /categories/<cat_ID>/products/<sku>/partOfRetailSet but without categories See REST API - Get list of products assigned to a retail set in category (until 7.8) | 7.4 |
| GET | REST API - Get list of products assigned to a retail set in category (until 7.8) | Retrieves products which are part of a given retail set | 7.4 |
GET | REST API - Get list of products category (until 7.8) | Get list of products of (sub-) category. | 7.4 |
GET | REST API - Get list of products using search engine | Equivalent to /categories/<catID>/products?productFilter=<searchQueryDefinitionID> but without categories See REST API - Get list of products using search engine category | 7.4 |
GET | REST API - Get list of products using search engine category | Get list of products of (sub-) category using search engine based product filters | 7.4 |
GET | REST API - Get list of products with pageable | Equivalent to /categories/<catID>/products?pageable=<pageableID> but without categories See REST API - Get list of products with pageable category | 7.4 |
| GET | REST API - Get list of products with pageable category | Get list of products of (sub-) category and use pageable IDs | 7.4 |
| GET | REST API - Get list of security questions | Get list of security questions | 7.4 |
GET | REST API - Get list of wish lists of business customer | Returns a list of links to customer wish list resources | 7.4 |
| GET | REST API - Get list of wish lists of private customer | Returns a list of links to customer wish list resources | 7.4 |
GET | REST API - Get order details (valid from 7.4 to 7.7) | Get detailed information of the order with given orderID for logged-in user | 7.4 |
| GET | REST API - Get order history list (until 7.8) | Get a list of links to orders of logged-in user | 7.4 |
GET | REST API - Get payment details from basket payments (until 7.7) | Returns details of the payment method | 7.6 |
| GET | REST API - Get payments of basket (until 7.8) | Returns a list with all selected payments for the basket | 7.4 |
| GET | REST API - Get personalized promotion list (until 7.8) | Get a personalized list of promotions available for the store. | 7.4 |
| GET | REST API - Get private customer profile details (until 7.8) | Gets the profile details of a currently authenticated private customer. | 7.4 |
GET | REST API - Get private customer wish list details | Retrieves and returns details about customer's wish list to the client | 7.5 |
| GET | REST API - Get product assigned categories (until 7.8) | Equivalent to /categories/<cat_ID>/products/<sku>/categories but without categories See REST API - Get product assigned categories in category (until 7.8) | 7.4 |
| GET | REST API - Get product assigned categories in category (until 7.8) | Get list of the implicitly and explicitly assigned categories to a product. | 7.4 |
GET | REST API - Get product attributes of view | Equivalent to /categories/<cat_ID>/products/<sku>?view=<namedViewID> but without categories See REST API - Get product attributes of view category | 7.4 |
GET | REST API - Get product attributes of view category | Get product attributes given by view | 7.4 |
GET | REST API - Get product cross sell data (until 7.8) | Equivalent to /categories/<cat_ID>/products/<sku>/crosssells but without categories. See REST API - Get product cross sell data category (until 7.8) | 7.4 |
GET | REST API - Get product cross sell data category (until 7.8) | Get the cross-sell data for a product. | 7.4 |
GET | REST API - Get product data (until 7.8) | Equivalent to /categories/<cat_ID>/products/<sku> but without categories | 7.4 |
| GET | REST API - Get product data category (until 7.6) | Get product data | 7.4 |
| GET | REST API - Get product links by link type (until 7.8) | Equivalent to /categories/<cat_ID>/products/<sku>/links but without categories See REST API - Get product links by link type and target objects (products or categories) (until 7.8) | 7.4 |
| GET | REST API - Get product links by link type and target objects (products or categories) (until 7.8) | Retrieves a list of products and a list of categories linked by the given product and filtered by the provided link type/target object. | 7.4 |
GET | REST API - Get product price notification details B2C | Retrieves details about customer's product price notification | 7.4 |
GET | REST API - Get product price notification details SMB | Retrieves details about customer's product price notification | 7.4 |
GET | REST API - Get product review by ID (until 7.8) | Get a product review by its ID | 7.4 |
GET | REST API - Get product reviews (until 7.8) | Get a list of reviews for a product | 7.4 |
GET | REST API - Get product stock notification details B2C | Retrieves and returns details about customer's product stock notification | 7.4 |
GET | REST API - Get product stock notification details SMB | Retrieves and returns details about customer's product stock notification | 7.4 |
GET | REST API - Get promotion details | Get relevant details for a promotion | 7.4 |
PUT | REST API - Get return-URLs from REST client for payment provider redirect (redirect before checkout) (until 7.8) | REST client delivers the return URLs to the system | 7.5 |
| GET | REST API - Get Search Suggestions | Retrieves the suggestions for a search term | 7.4 |
GET | REST API - Get selected product attributes | Equivalent to /categories/<cat_ID>/products/<sku>?attrs=<att1>,...,<attN> but without categories See REST API - Get selected product attributes category | 7.4 |
GET | REST API - Get selected product attributes category | Get selected product attributes | 7.4 |
GET | REST API - Get sorted list of products | Equivalent to /categories/<catID>/products?sortKey=<key>&returnSortKeys=<true or false>&productFilter=<searchQueryDefinitionID> but without categories See REST API - Get sorted list of products category | 7.4 |
GET | REST API - Get sorted list of products category | Get a sorted list of products of (sub-) category | 7.4 |
| GET | REST API - Get suggested address details (until 7.7) | Retrieves details about suggested address to the client | 7.4 |
| GET | REST API - Get the active basket (until 7.8) | Gets the summary of the active basket. | 7.5 |
GET | REST API - Get the applicable promotions for a product | Equivalent to /categories/<catID>/<subCatID>/.../products/<sku>/promotions but without categories See: REST API - Get the applicable promotions for a product category. | 7.4 |
GET | REST API - Get the applicable promotions for a product category | Get the applicable promotions for a product category | 7.4 |
| GET | REST API - Get the balance of a specific gift card or certificate B2C | Returns information about a specific gift card or certificate | 7.4 |
| GET | REST API - Get the balance of a specific gift card or certificate SMB | Get the balance of a specific gift card or certificate | 7.4 |
| GET | REST API - Get the gift cards and certificates B2C | Gets a list of URIs to the gift cards and certificates | 7.4 |
| GET | REST API - Get the gift cards and certificates SMB | Gets links to all cards and certificates | 7.4 |
GET | REST API - Get top level categories (until 7.9) | Retrieve the top-level navigation data (list of top-level categories) | 7.4 |
| POST | REST API - Get transaction details after redirect before checkout (until 7.8) | Transfer payment transaction information from the payment service provider, via the REST client to the shop system to activate there the payment transaction | 7.6 |
GET | REST API - Get variations for a master product (until 7.8) | Equivalent to /categories/<cat_ID>/products/<sku>/variations but without categories. See REST API - Get variations for a master product in category (until 7.8) | 7.5 |
GET | REST API - Get variations for a master product in category (until 7.8) | Returns a list of variations of a master product | 7.5 |
GET | REST API - Get wish list settings of business customer | Get customer wish list settings | 7.4 |
GET | REST API - Get wish list settings of private customer | Get customer wish list settings | 7.4 |
GET | REST API - List available filters | Return defined facet filters | 7.4 |
GET | REST API - List available filters for a specific filter | Return defined facet filters in the context of a selected filter | 7.4 |
GET | REST API - List available products for a specific filter | Return product links for the selected filter | 7.4 |
| PUT | REST API - Modify basket sub line item (until 7.8) | Modify the sublinetype of a specific basket item | 7.4 |
| GET | REST API - Profile details of user of a business customer (until 7.8) | Returns the profile details of user of a business customer | 7.4 |
GET | REST API - Public wish list details | Returns details about public wish list | 7.5 |
GET | REST API - Public wish lists | Returns a list of links to public wish lists | 7.4 |
| GET | REST API - Recommendation basket request | Get recommended products for the basket with the given basket ID | 7.5 |
POST | REST API - Recommendation events | Sends an event to the recommendation engine | 7.5 |
GET | REST API - Recommendation product request | Get recommended products for the given product (sku) | 7.5 |
| GET | REST API - Recommendation search request | Get recommended products for the given search term | 7.5 |
| GET | REST API - Recommendation top-seller request | Get recommended global topseller products | 7.5 |
GET | REST API - Recommendation user request | Get recommended products for the assigned user | 7.5 |
| POST | REST API - Register SMB customer (until 7.7) | Registers a customer. | 7.4 |
| DELETE | REST API - Remove a payment from Customer profile | Removes a payment method from the customer profile | 7.4 |
| DELETE | REST API - Remove payment from basket (until 7.8) | Removes selected payment method from basket payments. | 7.4 |
| POST | REST API - Request password reminder e-mail | Valid data submitted to this resource will trigger a password reminder process by sending an e-mail. | 7.4 |
| OPTIONS | REST API - Return basket line item options (until 7.8) | Returns all available options for the given line item | 7.4 |
| OPTIONS | REST API - Return basket options (until 7.8) | Returns all available options for the given basket | 7.5 |
| OPTIONS | REST API - Return payment options for basket (until 7.8) | Returns all available payment methods and their parameters available for this basket | 7.6 |
| OPTIONS | REST API - Return payment options for customers | Returns all available payment methods that can be added to the customer | 7.6 |
GET | REST API - Returns product notifications B2C | Returns two links to the stock and price resources | 7.4 |
POST | REST API - Send "Contact Us" e-mail | Triggers sending of "Contact Us" e-mail with data submitted with the request | 7.4 |
| PUT | REST API - Set basket line item related data (until 7.6) | Sets line item related data. | 7.5 |
PUT | REST API - Set basket related information (until 7.7) | Sets/updates basket related data. | 7.6 |
POST | REST API - Share wish list of business customer's user with given recipient | Shares a wish list of business customer's user with given recipient | 7.4 |
| POST | REST API - Share wish list of private customer with given recipient | Shares a wish list of private customer with given recipient | 7.4 |
GET | REST API - Shows subscription status for given recipient | Response of this URI will contain information about subscription status of given recipient to the e-mail provider configured for the application | 7.4 |
| GET | REST API - Store locator | Retrieves a list of stores and returns them to the client | 7.6 |
GET | REST API - Subjects for "Contact Us" | Returns a list of subject that has to be used when "Contact Us" e-mail is requested | 7.4 |
POST | REST API - Subscribe a recipient to an e-mail marketing provider | Subscribes a recipient, with an e-mail, to the e-mail marketing provider configured for the application | 7.4 |
DELETE | REST API - Unsubscribe recipient from an e-mail provider | Unsubscribes a recipient from e-mail marketing provider configured for the application | 7.4 |
| PUT | REST API - Update address details as suggested (until 7.7) | Updates an address details by using the ones provided from the suggestion address | 7.4 |
PUT | REST API - Update business customer wish list | Updates a customer wish list with wish list data provided from the client | 7.4 |
PUT | REST API - Update business customer wish list settings | Updates customer wish list settings with wish list settings data provided from the client | 7.4 |
| PUT | REST API - Update customer address (until 7.7) | Updates a customer address with address data provided from the client. | 7.5.1 |
| PUT | REST API - Update password | Updates password | 7.4 |
PUT | REST API - Update password of business customer's user | Updates password of business customer's user | 7.4 |
PUT | REST API - Update payment from customer profile | Updates a payment (with attributes) from customer profile | 7.4 |
| PUT | REST API - Update private customer profile (until 7.8) | Updates private customer profile | 7.4 |
PUT | REST API - Update private customer wish list | Updates a customer wish list with wish list data provided from the client | 7.4 |
PUT | REST API - Update private customer wish list settings | Updates customer wish list settings with wish list settings data provided from the client | 7.4 |
| PUT | REST API - Update product price notification B2C | Updates product price notification | 7.4 |
| PUT | REST API - Update product price notification SMB | Updates product price notification | 7.4 |
PUT | REST API - Update product stock notification B2C | Updates product stock notification | 7.4 |
PUT | REST API - Update product stock notification SMB | Updates product stock notification | 7.4 |
| PUT | REST API - Update profile of a customer's user (until 7.8) | Updates the profile of the currently logged in user. | 7.4 |
PUT | REST API - Update security question | Updates security question | 7.4 |
| PUT | REST API - Update security question of business customer's user | Updates security question of business customer's user | 7.4 |
| PUT | REST API - Update SMB customer profile (until 7.8) | Updates existing customer | 7.4 |
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.