Related Documents
Document Properties
Kbid283Z36
Last Modified08-Apr-2019
Added to KB04-Jul-2017
Public AccessEveryone
StatusOnline
Doc TypeReferences
ProductICM 7.9

Reference - WebShop REST API 7.9

Table of Contents

Product Version

7.9

Product To Version

7.9

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 front-end 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

POST

REST API - Add a payment to Customer profileAdds a payment method to the customer profile7.5.1

POST

REST API - Add new product reviewAdd new product review7.4

POST

REST API - Add payment to basketAdds a payment method to the basket7.9

POST

REST API - Add payment to business customer's recurring orderAdds a payment method to the recurring order of business customer7.8

POST

REST API - Add payment to individual customer's recurring orderAdds a payment method to the recurring order of an individual customer7.8

POST

REST API - Add product to a business customer wish listAdd a product to a business customer wish list with data provided by the client7.9

POST

REST API - Add product to a private customer wish listAdd a product to a private customer wish list with data provided by the client7.9

POST

REST API - Adds line items to basket / add quote items to basketAdds a list of items or line items of a quote to an existing basket7.9
POSTREST API - Assign cost object to basketAssigns a cost object to the basket7.9

PUT

REST API - Cancel orderCancel an order7.9
GET
REST API - CAPTCHA ChallengeResponds with script snippet containing CAPTCHA challenge7.5
GETREST API - Company profile detailsReturns a response containing company profile information7.9
POSTREST API - Create a line item for quote requestCreates a line item for the quote request with the given quoteRequestID7.7

POST

REST API - Create a new basketCreates a new basket7.9
POSTREST API - Create a quote requestCreates a quote request7.8

POST

REST API - Create individual customerCreates an individual customer7.8

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 cost object typeCreates a new cost object type7.9
POSTREST API - Create new customer addressCreates a new customer address by using POST data provided by the client7.8
POSTREST API - Create new orderCreates/submits an order7.9

POST

REST API - Create new private customer wish listCreates a new customer wish list7.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
POSTREST API - Create Recommendation contextCreates a new recommendation context7.5
GETREST API - Customer addresses listReturns a list of links to customer addresses resources7.8
DELETEREST API - Delete a line item of a quote requestDeletes a line item of a quote request7.7
DELETEREST API - Delete a quoteDeletes a quote7.7
DELETEREST API - Delete a quote requestDeletes a quote request7.7
DELETEREST API - Delete basket sub line itemDelete the sublinetype of a specific basket item7.9

DELETE

REST API - Delete business customer wish listDelete a customer wish list7.4
DELETEREST API - Delete cost object typeDeletes the cost object type7.9
DELETEREST API - Delete customer addressDeletes a customer address7.8

DELETE

REST API - Delete item from basket by its IDRemoves the specified line item from basket7.9

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 line item of a quote requestGets a line item of a quote request7.7

GET

REST API - Get a list of active basketsGets all open baskets for the current user7.9
GETREST API - Get a list of quote requestsRetrieves a list of quote requests7.7
GETREST API - Get a list of quotesRetrieves a list of quotes, optionally filtered by the quote state7.7

GET

REST API - Get all line items of the basketGets all line items contained in the given basket7.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
GETREST API - Get basket cost objectReturns a cost object that was set to the basket7.9
GETREST API - Get basket cost objectsReturns the cost objects that are assigned to the basket7.9

GET

REST API - Get basket item by IDGet the specified line item from basket7.9

GET

REST API - Get basket sub line item by typeGet the sub-line type of a specific basket item7.9
GETREST API - Get business customer user's profile detailsReturns the profile details of a user of a business customer7.9
GETREST API - Get business customer user's recurring order detailsReturns details about customer user's recurring order to the client7.8

GET

REST API - Get business customer wish list detailsRetrieves and returns details about customer's wish list to the client7.5
GETREST API - Get business customer's recurring order detailsReturns details about business customer's recurring order to the client. Requires account administrator permissions.7.8
GETREST API - Get Business User Cost Center DetailsReturns the details of a specified cost center of a business user7.8
GETREST API - Get business user's list of cost centersReturns a list of cost centers of the given user of a business customer7.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 object7.4
GETREST API - Get cost object typeReturns a specific cost object type7.9
GETREST API - Get cost object typesReturns cost object types7.9
GETREST API - Get customer address detailsReturns details about customer's address to the client7.8

GET

REST API - Get customer contract detailsGet detailed information about the contract with the given contractUUID7.6

GET

REST API - Get customer contract ordersGet all orders related to the contract with the given contractUUID7.6

GET

REST API - Get customer contractsGets all contracts of a customer7.6

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 individual customer's profile detailsReturns the profile details of a currently authenticated private customer7.9
GETREST API - Get individual customer's recurring order detailsReturns details about customer's recurring order to the client7.8

GET

REST API - Get info on (sub-)categoryReturns info about (sub-) category7.9

GET

REST API - Get list of bundles for product bundleEquivalent to /categories/<cat_ID>/products/<sku>/bundles but without categories, see REST API - Get list of bundles for product bundle in category7.9

GET

REST API - Get list of bundles for product bundle in categoryReturns list of bundles for product bundle7.9
GETREST API - Get list of business customer user's recurring ordersReturns a list of recurring orders of the given user of a business customer7.8
GET
REST API - Get list of business user's recurring ordersReturns a list of links of all recurring orders for the customer. Account administrator permissions required.7.8
GETREST API - Get list of Customer profile paymentsReturns a list of payment methods of the customer profile7.4
GET
REST API - Get list of individual customer's recurring ordersReturns a list of recurring orders of the given individual customer7.8
GETREST API - Get list of line items of a quote requestGets the list of line items of a quote request7.7
GETREST API - Get list of links to suggested addressesReturns a list of resources' links that a client could access to view suggested addresses details7.8

GET

REST API - Get list of productsEquivalent 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 setEquivalent 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 categoryRetrieves products which are part of a given retail set7.9

GET

REST API - Get list of products categoryReturns a list of products of a (sub-) category7.9

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
GETREST API - Get order cost objectReturns a specific cost object that is assigned to the order7.9
GETREST API - Get order cost objectsReturns the cost objects that are assigned to the order7.9

GET

REST API - Get order details (7.9)Get detailed information of the order with given orderID for logged-in user7.9

GET

REST API - Get order history listGet a list of links to orders of logged-in user7.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 paymentsReturns details of the payment method7.8

GET

REST API - Get payment details of individual customer's recurring order paymentsReturns the details of the payment method7.8

OPTIONS

REST API - Get payment options of business customer's recurring orderReturns available payment methods for the recurring order of a business customer7.8

GET

REST API - Get payments of basketReturns a list with all selected payments for the basket7.9

GET

REST API - Get payments of business customer's recurring orderReturns a list of all selected payments for the recurring order of a business customer7.8

GET

REST API - Get payments of individual customer's recurring orderReturns a list with all selected payment methods for the recurring order of an individual customer7.8

GET

REST API - Get Personalization IDReturns a unique personalization ID based on user credentials7.9
GET
REST API - Get personalized category listRetrieve 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 productsGet 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 categoryGet 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 assignmentsEquivalent 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:

  • variations
  • reviews
  • promotions
  • crosssells
  • bundles
  • partOfRetailSet
  • links
  • categories

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 dataGets 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 categoryGets 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 listGet a personalized list of promotions available for the store7.9

GET

REST API - Get private customer wish list detailsRetrieves and returns details about customer's wish list to the client7.5

GET

REST API - Get product assigned categoriesEquivalent 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 categoryReturns a list of the implicitly and explicitly assigned categories to a product7.9

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 dataEquivalent 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 categoryReturns the cross-sell data for a product7.9

GET

REST API - Get product data

Equivalent to /categories/<cat_ID>/products/<sku> but without categories

See REST API - Get product data category

7.9

GET

REST API - Get product data categoryGets product data7.9
GETREST API - Get product data category with product price based on a addressGets product data with prices based on the given addresses or the basket address7.7
GETREST 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 typeEquivalent 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 object7.9

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 IDReturns a product review by its ID7.9

GET

REST API - Get product reviewsReturns a list of reviews for a product7.9

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
PUTREST API - Get return-URLs from REST client for payment provider redirect (redirect before checkout)REST client delivers the return URLs to the system7.9
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
GETREST API - Get sorted list of products categoryGet a sorted list of products of (sub-) category7.4
GETREST API - Get suggested address detailsReturns details about suggested address to the client7.8
GETREST 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
GETREST API - Get the quote detailsShows the details of a quote7.7
GETREST API - Get the quote request detailsShows the details of a quote request7.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 checkoutTransfer payment transaction information from the payment service provider via the REST client to the shop system to activate the payment transaction there7.9

GET

REST API - Get variations for a master product

Equivalent to /categories/<cat_ID>/products/<sku>/variations but without categories,
see REST API - Get variations for a master product in category


7.9

GET

REST API - Get variations for a master product in categoryReturns a list of variations of a master product7.9

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
GETREST 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 itemModify the sublinetype of a specific basket item7.9

GET

REST API - Public wish list detailsReturns details about public wish list7.5

GET

REST API - Public wish listsReturns a list of links to public wish lists7.4

GET

REST API - Punchout - Get Punchout user detailsReturns information on the given Punchout user7.8

POST

REST API - Punchout - Create a Punchout userCreate a Punchout user7.8

DELETE

REST API - Punchout - Delete a Punchout userDelete a Punchout-specific user of a customer7.8
GET
REST API - Punchout - Get Punchout configurationReturns the Punchout related customer specific configurations7.8
GET
REST API - Punchout - Get Punchout item detailsReturns details for the selected Punchout standard7.9

GET

REST API - Punchout - Get punchout usersReturns all users for the selected Punchout standard7.8

GET

REST API - Punchout - Get supported Punchout StandardsReturns all supported Punchout standards7.9

OPTIONS

REST API - Punchout - Return available configuration options for PunchoutReturns all available configuration options for the selected Punchout standard7.9
PUT
REST API - Punchout - Update Punchout configurationUpdate the existing Punchout configuration7.8

PUT

REST API - Punchout - Update Punchout user informationUpdate Punchout user data7.8
GETREST API - Recommendation basket requestGet recommended products for the basket with the given basket ID 7.5
POST
REST API - Recommendation eventsSends an event to the recommendation engine7.5
GET
REST API - Recommendation product requestGet recommended products for the given product (sku)7.5
GETREST API - Recommendation search requestGet recommended products for the given search term7.5
GETREST API - Recommendation top-seller requestGet recommended global topseller products7.5
GET
REST API - Recommendation user requestGet recommended products for the assigned user7.5

POST

REST API - Register SMB CustomerRegisters a customer7.8
PUT
REST API - Reject a quoteRejects a quote7.7
DELETEREST API - Remove a payment from Customer profileRemoves a payment method from the customer profile7.4
DELETEREST API - Remove basket cost objectRemoves a cost object from the basket7.9

DELETE

REST API - Remove payment from basketRemoves selected payment method from basket payments7.9

DELETE

REST API - Remove payment from business customer's recurring orderRemoves selected payment method from recurring order payments7.8

DELETE

REST API - Remove payment from individual customer's recurring orderRemoves selected payment method from recurring order payments7.8
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 optionsReturns all available options for the given line item7.9
OPTIONSREST API - Return basket optionsReturns all available options for the given basket7.9

OPTIONS

REST API - Return payment options for basket (7.9)Returns all available payment methods and their parameters available for this basket7.9
OPTIONSREST API - Return payment options for customersReturns all available payment methods that can be added to the customer7.6

OPTIONS

REST API - Return payment options of individual customer's recurring orderReturns available payment methods for the recurring order of an individual customer7.8

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 dataSets line item related data7.9
PUTREST API - Set basket related informationSets/updates basket related data, marks the basket as recurrent and sets recurrence information7.9
PUTREST API - Set quote request line itemsSets the list of quote line items7.7

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 locatorRetrieves a list of stores and returns them to the client7.6

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
POSTREST API - Submit a quote requestSubmits a quote request7.7

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 a line item of a quote requestUpdates the line item of a quote request (quantity)7.7
PUTREST API - Update address details as suggestedUpdates address details by using the ones provided from the suggestion address7.8

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 business customer's recurring orderUpdates a recurring order, supports only activation and deactivation7.8
PUTREST API - Update cost object typeUpdates a cost object type7.9
PUTREST API - Update customer addressUpdates a customer address with address data provided from the client7.8
PUTREST API - Update data of a quote requestUpdates data of a quote request7.7

PUT

REST API - Update individual customer's profileUpdates individual customer's profile7.9
PUT
REST API - Update individual customer's recurring orderUpdates a recurring order, supports only activation and deactivation7.8
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

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 customer's userUpdates the profile of the currently logged in user7.9

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

PUT

REST API - Update SMB customer profileUpdates existing customer7.9

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