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 front-end solutions.
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 | Adds a payment method to the basket | 7.9 |
POST | REST API - Add payment to business customer's recurring order | Adds a payment method to the recurring order of business customer | 7.8 |
POST | REST API - Add payment to individual customer's recurring order | Adds a payment method to the recurring order of an individual customer | 7.8 |
POST | REST API - Add product to a business customer wish list | Add a product to a business customer wish list with data provided by the client | 7.9 |
POST | REST API - Add product to a private customer wish list | Add a product to a private customer wish list with data provided by the client | 7.9 |
POST | REST API - Adds line items to basket / add quote items to basket | Adds a list of items or line items of a quote to an existing basket | 7.9 |
POST | REST API - Assign cost object to basket | Assigns a cost object to the basket | 7.9 |
PUT | REST API - Cancel order | Cancel an order | 7.9 |
GET | REST API - CAPTCHA Challenge | Responds with script snippet containing CAPTCHA challenge | 7.5 |
GET | REST API - Company profile details | Returns a response containing company profile information | 7.9 |
POST | REST API - Create a line item for quote request | Creates a line item for the quote request with the given quoteRequestID | 7.7 |
POST | REST API - Create a new basket | Creates a new basket | 7.9 |
POST | REST API - Create a quote request | Creates a quote request | 7.8 |
POST | REST API - Create individual customer | Creates an individual customer | 7.8 |
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 cost object type | Creates a new cost object type | 7.9 |
POST | REST API - Create new customer address | Creates a new customer address by using POST data provided by the client | 7.8 |
POST | REST API - Create new order | Creates/submits an order | 7.9 |
POST | REST API - Create new private customer wish list | Creates a new customer wish list | 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 | Returns a list of links to customer addresses resources | 7.8 |
DELETE | REST API - Delete a line item of a quote request | Deletes a line item of a quote request | 7.7 |
DELETE | REST API - Delete a quote | Deletes a quote | 7.7 |
DELETE | REST API - Delete a quote request | Deletes a quote request | 7.7 |
DELETE | REST API - Delete basket sub line item | Delete the sublinetype of a specific basket item | 7.9 |
DELETE | REST API - Delete business customer wish list | Delete a customer wish list | 7.4 |
DELETE | REST API - Delete cost object type | Deletes the cost object type | 7.9 |
DELETE | REST API - Delete customer address | Deletes a customer address | 7.8 |
DELETE | REST API - Delete item from basket by its ID | Removes the specified line item from basket | 7.9 |
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 line item of a quote request | Gets a line item of a quote request | 7.7 |
GET | REST API - Get a list of active baskets | Gets all open baskets for the current user | 7.9 |
GET | REST API - Get a list of quote requests | Retrieves a list of quote requests | 7.7 |
GET | REST API - Get a list of quotes | Retrieves a list of quotes, optionally filtered by the quote state | 7.7 |
GET | REST API - Get all line items of the basket | Gets all line items contained in the given basket | 7.9 |
GET | REST API - Get basket by ID | Returns the basket's summary. Alternatively you may use the URL /baskets/- to get the active basket. | 7.9 |
GET | REST API - Get basket cost object | Returns a cost object that was set to the basket | 7.9 |
GET | REST API - Get basket cost objects | Returns the cost objects that are assigned to the basket | 7.9 |
GET | REST API - Get basket item by ID | Get the specified line item from basket | 7.9 |
GET | REST API - Get basket sub line item by type | Get the sub-line type of a specific basket item | 7.9 |
GET | REST API - Get business customer user's profile details | Returns the profile details of a user of a business customer | 7.9 |
GET | REST API - Get business customer user's recurring order details | Returns details about customer user's recurring order to the client | 7.8 |
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 business customer's recurring order details | Returns details about business customer's recurring order to the client. Requires account administrator permissions. | 7.8 |
GET | REST API - Get Business User Cost Center Details | Returns the details of a specified cost center of a business user | 7.8 |
GET | REST API - Get business user's list of cost centers | Returns a list of cost centers of the given user of a business customer | 7.8 |
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 cost object type | Returns a specific cost object type | 7.9 |
GET | REST API - Get cost object types | Returns cost object types | 7.9 |
GET | REST API - Get customer address details | Returns details about customer's address to the client | 7.8 |
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 individual customer's profile details | Returns the profile details of a currently authenticated private customer | 7.9 |
GET | REST API - Get individual customer's recurring order details | Returns details about customer's recurring order to the client | 7.8 |
GET | REST API - Get info on (sub-)category | Returns info about (sub-) category | 7.9 |
GET | REST API - Get list of bundles for product bundle | Equivalent to /categories/<cat_ID>/products/<sku>/bundles but without categories, see REST API - Get list of bundles for product bundle in category | 7.9 |
GET | REST API - Get list of bundles for product bundle in category | Returns list of bundles for product bundle | 7.9 |
GET | REST API - Get list of business customer user's recurring orders | Returns a list of recurring orders of the given user of a business customer | 7.8 |
GET | REST API - Get list of business user's recurring orders | Returns a list of links of all recurring orders for the customer. Account administrator permissions required. | 7.8 |
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 individual customer's recurring orders | Returns a list of recurring orders of the given individual customer | 7.8 |
GET | REST API - Get list of line items of a quote request | Gets the list of line items of a quote request | 7.7 |
GET | REST API - Get list of links to suggested addresses | Returns a list of resources' links that a client could access to view suggested addresses details | 7.8 |
GET | REST API - Get list of products | Equivalent to /categories/<catID>/products?amount=<amount>&offset=<offset> but without categories, see REST API - Get list of products category | 7.9 |
GET | REST API - Get list of products assigned to a retail set | 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. | 7.9 |
GET | REST API - Get list of products assigned to a retail set in category | Retrieves products which are part of a given retail set | 7.9 |
GET | REST API - Get list of products category | Returns a list of products of a (sub-) category | 7.9 |
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 cost object | Returns a specific cost object that is assigned to the order | 7.9 |
GET | REST API - Get order cost objects | Returns the cost objects that are assigned to the order | 7.9 |
GET | REST API - Get order details (7.9) | Get detailed information of the order with given orderID for logged-in user | 7.9 |
GET | REST API - Get order history list | Get a list of links to orders of logged-in user | 7.9 |
GET | REST API - Get payment details from basket payments (7.9) | Returns details of the payment method | 7.9 |
GET | REST API - Get payment details of business customer's recurring order payments | Returns details of the payment method | 7.8 |
GET | REST API - Get payment details of individual customer's recurring order payments | Returns the details of the payment method | 7.8 |
OPTIONS | REST API - Get payment options of business customer's recurring order | Returns available payment methods for the recurring order of a business customer | 7.8 |
GET | REST API - Get payments of basket | Returns a list with all selected payments for the basket | 7.9 |
GET | REST API - Get payments of business customer's recurring order | Returns a list of all selected payments for the recurring order of a business customer | 7.8 |
GET | REST API - Get payments of individual customer's recurring order | Returns a list with all selected payment methods for the recurring order of an individual customer | 7.8 |
GET | REST API - Get Personalization ID | Returns a unique personalization ID based on user credentials | 7.9 |
GET | REST API - Get personalized category list | Retrieve the top-level navigation data (list of top-level categories) or get info about (sub-) category. If page cache is enabled and spgid parameter is provided with a valid personalization group ID - Web Adapter caches this user specific response. | 7.8 |
GET | REST API - Get personalized list of products | Get a list of products. If page cache is enabled and spgid parameter is provided with a valid personalization group ID - the Web Adapter caches this user specific response. | 7.8 |
GET | REST API - Get personalized list of products category | Get a list of products of a (sub-) category. If the page cache is enabled and spgid parameter is provided with a valid personalization group ID - the Web Adapter caches this user specific response. | 7.8 |
GET | REST API - Get personalized product assignments | Equivalent to /categories/<catID>/products;spgid=<personalization_group_id>/<sku>/<assignment> but without category. See REST API - Get personalized product assignments category. | 7.8 |
GET | REST API - Get personalized product assignments category | Gets a particular product assignment list, e.g. /<assignment> is one of the following sub resources:
If page cache is enabled and a spgid parameter is provided with a valid personalization group ID, the Web Adapter caches this user specific response. | 7.8 |
GET | REST API - Get personalized product data | Gets product data. If page cache is enabled and the spgid parameter is provided with a valid personalization group ID, the Web Adapter caches this user specific response. | 7.8 |
GET | REST API - Get personalized product data category | Gets product data. If page cache is enabled and the spgid parameter is provided with a valid personalization group ID, the Web Adapter caches this user specific response. | 7.8 |
GET | REST API - Get personalized promotion list | Get a personalized list of promotions available for the store | 7.9 |
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 | Equivalent to /categories/<cat_ID>/products/<sku>/categories but without categories, see REST API - Get product assigned categories in category | 7.9 |
GET | REST API - Get product assigned categories in category | Returns a list of the implicitly and explicitly assigned categories to a product | 7.9 |
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 | Equivalent to /categories/<cat_ID>/products/<sku>/crosssells but without categories, see REST API - Get product cross sell data category | 7.9 |
GET | REST API - Get product cross sell data category | Returns the cross-sell data for a product | 7.9 |
GET | REST API - Get product data | Equivalent to /categories/<cat_ID>/products/<sku> but without categories | 7.9 |
GET | REST API - Get product data category | Gets product data | 7.9 |
GET | REST API - Get product data category with product price based on a address | Gets product data with prices based on the given addresses or the basket address | 7.7 |
GET | REST API - Get product data with price based on a address | Equivalent to /categories/<cat_ID>/products/<sku>?basketId=aBasketId but without categories See REST API - Get product data category with product price based on a address | 7.7 |
GET | REST API - Get product links by link type | 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) | 7.9 |
GET | REST API - Get product links by link type and target objects (products or categories) | Returns a list of products and a list of categories linked by the given product and filtered by the provided link type/target object | 7.9 |
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 | Returns a product review by its ID | 7.9 |
GET | REST API - Get product reviews | Returns a list of reviews for a product | 7.9 |
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) | REST client delivers the return URLs to the system | 7.9 |
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 | Returns details about suggested address to the client | 7.8 |
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 the quote details | Shows the details of a quote | 7.7 |
GET | REST API - Get the quote request details | Shows the details of a quote request | 7.7 |
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 | Transfer payment transaction information from the payment service provider via the REST client to the shop system to activate the payment transaction there | 7.9 |
GET | REST API - Get variations for a master product | Equivalent to /categories/<cat_ID>/products/<sku>/variations but without categories, | 7.9 |
GET | REST API - Get variations for a master product in category | Returns a list of variations of a master product | 7.9 |
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 | Modify the sublinetype of a specific basket item | 7.9 |
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 - Punchout - Get Punchout user details | Returns information on the given Punchout user | 7.8 |
POST | REST API - Punchout - Create a Punchout user | Create a Punchout user | 7.8 |
DELETE | REST API - Punchout - Delete a Punchout user | Delete a Punchout-specific user of a customer | 7.8 |
GET | REST API - Punchout - Get Punchout configuration | Returns the Punchout related customer specific configurations | 7.8 |
GET | REST API - Punchout - Get Punchout item details | Returns details for the selected Punchout standard | 7.9 |
GET | REST API - Punchout - Get punchout users | Returns all users for the selected Punchout standard | 7.8 |
GET | REST API - Punchout - Get supported Punchout Standards | Returns all supported Punchout standards | 7.9 |
OPTIONS | REST API - Punchout - Return available configuration options for Punchout | Returns all available configuration options for the selected Punchout standard | 7.9 |
PUT | REST API - Punchout - Update Punchout configuration | Update the existing Punchout configuration | 7.8 |
PUT | REST API - Punchout - Update Punchout user information | Update Punchout user data | 7.8 |
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 | Registers a customer | 7.8 |
PUT | REST API - Reject a quote | Rejects a quote | 7.7 |
DELETE | REST API - Remove a payment from Customer profile | Removes a payment method from the customer profile | 7.4 |
DELETE | REST API - Remove basket cost object | Removes a cost object from the basket | 7.9 |
DELETE | REST API - Remove payment from basket | Removes selected payment method from basket payments | 7.9 |
DELETE | REST API - Remove payment from business customer's recurring order | Removes selected payment method from recurring order payments | 7.8 |
DELETE | REST API - Remove payment from individual customer's recurring order | Removes selected payment method from recurring order payments | 7.8 |
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 | Returns all available options for the given line item | 7.9 |
OPTIONS | REST API - Return basket options | Returns all available options for the given basket | 7.9 |
OPTIONS | REST API - Return payment options for basket (7.9) | Returns all available payment methods and their parameters available for this basket | 7.9 |
OPTIONS | REST API - Return payment options for customers | Returns all available payment methods that can be added to the customer | 7.6 |
OPTIONS | REST API - Return payment options of individual customer's recurring order | Returns available payment methods for the recurring order of an individual customer | 7.8 |
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 | Sets line item related data | 7.9 |
PUT | REST API - Set basket related information | Sets/updates basket related data, marks the basket as recurrent and sets recurrence information | 7.9 |
PUT | REST API - Set quote request line items | Sets the list of quote line items | 7.7 |
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 - Submit a quote request | Submits a quote request | 7.7 |
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 a line item of a quote request | Updates the line item of a quote request (quantity) | 7.7 |
PUT | REST API - Update address details as suggested | Updates address details by using the ones provided from the suggestion address | 7.8 |
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 business customer's recurring order | Updates a recurring order, supports only activation and deactivation | 7.8 |
PUT | REST API - Update cost object type | Updates a cost object type | 7.9 |
PUT | REST API - Update customer address | Updates a customer address with address data provided from the client | 7.8 |
PUT | REST API - Update data of a quote request | Updates data of a quote request | 7.7 |
PUT | REST API - Update individual customer's profile | Updates individual customer's profile | 7.9 |
PUT | REST API - Update individual customer's recurring order | Updates a recurring order, supports only activation and deactivation | 7.8 |
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 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 customer's user | Updates the profile of the currently logged in user | 7.9 |
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 | Updates existing customer | 7.9 |
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.