Related Documents
Document Properties
Kbid27V715
Last Modified14-Jun-2019
Added to KB20-Jul-2016
Public AccessEveryone
StatusOnline
Doc TypeReferences

Reference - WebShop REST API (7.4 - 7.4 CI)

Table of Contents

Product Version

7.4

Product To Version

7.4.6

Status

final

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.

MethodTitleDescriptionValid From

GET

REST API - Get productlist by global searchGet list of items by global product search7.4

GET

REST API - Returns product notifications SMBReturns two links to the stock and price resources7.4
POSTREST API - Add a payment to Customer profile (until 7.5.0)Adds a payment method to the customer profile7.4

POST

REST API - Add new product reviewAdd new product review7.4
POSTREST API - Add Payment to basket (until 7.4 CI)Adds a payment method to the basket7.4
POSTREST API - Add to Cart (valid from 7.4 to 7.6)Adds a list of items to an existing cart.7.4
PUTREST API - Cancel order (until 7.8)Cancel an Order7.4
GETREST API - Company profile details (until 7.8)Returns a response containing company profile information.7.4
POSTREST API - Create a new basket (until 7.8)Creates a new basket.7.4

POST

REST API - Create new business customer wish listCreates a new customer wish list by using POST data provided by the client7.4
POSTREST API - Create new customer address (until 7.5.0)Creates a new customer address by using POST data provided by the client7.4
POSTREST API - Create new order (valid until 7.4 CI)Creates/submits an order7.4

POST

REST API - Create new private customer wish listCreates a new customer wish list7.4
POSTREST API - Create private customer (until 7.7)Creates a private customer7.4
POSTREST API - Create product price notification B2CCreates product price notification7.4
POSTREST API - Create product price notification SMBCreates product price notification7.4

POST

REST API - Create product stock notification B2CCreates product stock notification7.4

POST

REST API - Create product stock notification SMBCreates product stock notification7.4
GETREST API - Customer addresses list (until 7.7)Returns a list of links to customer addresses resources.7.4
DELETEREST API - Delete basket sub line item (until 7.8)Delete the sublinetype of a specific basket item7.4

DELETE

REST API - Delete business customer wish listDelete a customer wish list7.4
DELETEREST API - Delete customer address (until 7.7)Delete a customer address.7.4
DELETEREST 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 listDelete a customer wish list7.4

DELETE

REST API - Delete product price notification B2CDeletes a product price notification7.4
DELETEREST API - Delete product price notification SMBDeletes product price notification7.4
DELETEREST API - Delete product review by idDeletes a product review by its ID7.4

DELETE

REST API - Delete product stock notification B2CDeletes a product stock notification7.4

DELETE

REST API - Delete product stock notification SMBDeletes product stock notification7.4
GETREST API - Get a list of active baskets (until 7.8)Gets all open baskets for the current user.7.4
GETREST 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 details7.4
GETREST API - Get all line items of the basket (until 7.8)Gets all line items contained in the given basket.7.4
GETREST API - Get basket by ID (until 7.4 CI)Returns the basket's summary.7.4
GETREST API - Get basket item by ID (until 7.8)Get the specified line item from basket.7.4
GETREST API - Get basket sub line item by type (until 7.8)Get the sub-line type of a specific basket item.7.4
GETREST API - Get business customer wish list details (until 7.4 CI)Retrieves and returns details about customer's wish list to the client.7.4

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 object7.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 details of a customer profile payment (until 7.9)Returns the details of a payment method from the customer profile7.4
GETREST 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
GETREST API - Get list of bundles for product bundle in category (until 7.8)Get list of bundles for product bundle7.4
GETREST API - Get list of Customer profile paymentsReturns a list of payment methods of the customer profile7.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
GETREST 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
GETREST API - Get list of products assigned to a retail set in category (until 7.8)Retrieves products which are part of a given retail set7.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 engineEquivalent 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 categoryGet list of products of (sub-) category using search engine based product filters7.4

GET

REST API - Get list of products with pageableEquivalent to /categories/<catID>/products?pageable=<pageableID> but without categories
See REST API - Get list of products with pageable category
7.4
GETREST API - Get list of products with pageable categoryGet list of products of (sub-) category and use pageable IDs7.4
GETREST API - Get list of security questionsGet list of security questions7.4

GET

REST API - Get list of wish lists of business customerReturns a list of links to customer wish list resources7.4
GETREST API - Get list of wish lists of private customerReturns a list of links to customer wish list resources7.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 user7.4
GETREST API - Get order history list (until 7.8)Get a list of links to orders of logged-in user7.4
GETREST API - Get Payment details from basket payments (until 7.4 CI)Returns details of the payment method7.4
GETREST API - Get payments of basket (until 7.8)Returns a list with all selected payments for the basket7.4
GETREST API - Get personalized promotion list (until 7.8)Get a personalized list of promotions available for the store.7.4
GETREST API - Get private customer profile details (until 7.8)Gets the profile details of a currently authenticated private customer.7.4
GETREST API - Get private customer wish list details (until 7.4 CI)Retrieves and returns details about customer's wish list to the client.7.4
GETREST 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
GETREST 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 viewEquivalent 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 categoryGet product attributes given by view7.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

See REST API - Get product data category (until 7.8)

7.4
GETREST API - Get product data category (until 7.6)Get product data7.4
GETREST 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
GETREST 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 B2CRetrieves details about customer's product price notification7.4

GET

REST API - Get product price notification details SMBRetrieves details about customer's product price notification7.4

GET

REST API - Get product review by ID (until 7.8)Get a product review by its ID7.4

GET

REST API - Get product reviews (until 7.8)Get a list of reviews for a product7.4

GET

REST API - Get product stock notification details B2CRetrieves and returns details about customer's product stock notification7.4

GET

REST API - Get product stock notification details SMBRetrieves and returns details about customer's product stock notification7.4

GET

REST API - Get promotion detailsGet relevant details for a promotion7.4
GETREST API - Get Search SuggestionsRetrieves the suggestions for a search term7.4

GET

REST API - Get selected product attributesEquivalent 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 categoryGet selected product attributes7.4

GET

REST API - Get sorted list of productsEquivalent 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 categoryGet a sorted list of products of (sub-) category7.4
GETREST API - Get suggested address details (until 7.7)Retrieves details about suggested address to the client7.4
GETREST API - Get the active basket (until 7.4 CI)Gets the summary of the active basket.7.4

GET

REST API - Get the applicable promotions for a productEquivalent 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 categoryGet the applicable promotions for a product category7.4
GETREST API - Get the balance of a specific gift card or certificate B2CReturns information about a specific gift card or certificate7.4
GETREST API - Get the balance of a specific gift card or certificate SMBGet the balance of a specific gift card or certificate7.4
GETREST API - Get the gift cards and certificates B2CGets a list of URIs to the gift cards and certificates7.4
GETREST API - Get the gift cards and certificates SMBGets links to all cards and certificates7.4

GET

REST API - Get top level categories (until 7.9)Retrieve the top-level navigation data (list of top-level categories)7.4
GETREST API - Get variations for a master product (until 7.4)Equivalent to /categories/<cat_ID>/products/<sku>/variations but without categories
See REST API - Get variations for a master product in category (until 7.4)
7.4
GETREST API - Get variations for a master product in category (until 7.4)Get list of variations of product master7.4

GET

REST API - Get wish list settings of business customerGet customer wish list settings7.4

GET

REST API - Get wish list settings of private customerGet customer wish list settings7.4

GET

REST API - List available filtersReturn defined facet filters7.4

GET

REST API - List available filters for a specific filterReturn defined facet filters in the context of a selected filter7.4

GET

REST API - List available products for a specific filterReturn product links for the selected filter7.4
PUTREST API - Modify basket sub line item (until 7.8)Modify the sublinetype of a specific basket item7.4
GETREST API - Profile details of user of a business customer (until 7.8)Returns the profile details of user of a business customer7.4
GETREST API - Public wish list details (until 7.4 CI)Returns a details view of a public wish list.7.4

GET

REST API - Public wish listsReturns a list of links to public wish lists7.4
POSTREST API - Register SMB customer (until 7.7)Registers a customer.7.4
DELETEREST API - Remove a payment from Customer profileRemoves a payment method from the customer profile7.4
DELETEREST API - Remove payment from basket (until 7.8)Removes selected payment method from basket payments.7.4
POSTREST API - Request password reminder e-mailValid data submitted to this resource will trigger a password reminder process by sending an e-mail.7.4
OPTIONSREST API - Return basket line item options (until 7.8)Returns all available options for the given line item7.4
OPTIONSREST API - Return payment options for basket (valid from 7.4 to 7.4 CI)Returns all available payment methods and their parameters available for this basket7.4

GET

REST API - Returns product notifications B2CReturns two links to the stock and price resources7.4

POST

REST API - Send "Contact Us" e-mailTriggers sending of "Contact Us" e-mail with data submitted with the request7.4
PUTREST API - Set basket line item related data (until 7.4 CI)Sets line item related data.7.4
PUTREST API - Set basket related information (until 7.4 CI)Sets/updates basket related data.7.4

POST

REST API - Share wish list of business customer's user with given recipientShares a wish list of business customer's user with given recipient7.4
POSTREST API - Share wish list of private customer with given recipientShares a wish list of private customer with given recipient7.4

GET

REST API - Shows subscription status for given recipientResponse of this URI will contain information about subscription status of given recipient to the e-mail provider configured for the application7.4
GETREST API - Store locator (until 7.5)Retrieves a list of stores and returns them to the client7.4

GET

REST API - Subjects for "Contact Us"Returns a list of subject that has to be used when "Contact Us" e-mail is requested7.4

POST

REST API - Subscribe a recipient to an e-mail marketing providerSubscribes a recipient, with an e-mail, to the e-mail marketing provider configured for the application7.4

DELETE

REST API - Unsubscribe recipient from an e-mail providerUnsubscribes a recipient from e-mail marketing provider configured for the application7.4
PUTREST API - Update address details as suggested (until 7.7)Updates an address details by using the ones provided from the suggestion address7.4

PUT

REST API - Update business customer wish listUpdates a customer wish list with wish list data provided from the client7.4

PUT

REST API - Update business customer wish list settingsUpdates customer wish list settings with wish list settings data provided from the client7.4
PUTREST API - Update customer address (valid until 7.5.0)Updates a customer address with address data provided from the client7.4
PUTREST API - Update passwordUpdates password7.4

PUT

REST API - Update password of business customer's userUpdates password of business customer's user7.4

PUT

REST API - Update payment from customer profileUpdates a payment (with attributes) from customer profile7.4
PUTREST API - Update private customer profile (until 7.8)Updates private customer profile7.4

PUT

REST API - Update private customer wish listUpdates a customer wish list with wish list data provided from the client7.4

PUT

REST API - Update private customer wish list settingsUpdates customer wish list settings with wish list settings data provided from the client7.4
PUTREST API - Update product price notification B2CUpdates product price notification7.4
PUTREST API - Update product price notification SMBUpdates product price notification7.4

PUT

REST API - Update product stock notification B2CUpdates product stock notification7.4

PUT

REST API - Update product stock notification SMBUpdates product stock notification7.4
PUTREST 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 questionUpdates security question7.4
PUTREST API - Update security question of business customer's userUpdates security question of business customer's user7.4
PUTREST API - Update SMB customer profile (until 7.8)Updates existing customer7.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.

Customer Support
Knowledge Base
Product Resources
Support Tickets