Personal Library

Guide - 7.10 REST API Changes

Intershop Commerce Management REST API

There are the following changes in basket/order related REST APIs to:

Get a stringent naming scheme (SalesPricingRO, ShippingPricingRO, TotalsRO)
Avoid errors in generated Swagger schema (MoneyRO, QuantityRO)
Be prepared for future use (TaxItemRO, JurisdictionRO, ImpositionRO)

Version	API	Element	Change	Compatibility	Comment
7.10.7.3	Order Submission/OrderHistory (beta) Note This API is a beta version and still subject to changes.	`MoneyRO`	Attribute `currency` is no longer read-only.	incompatible
		`MoneyRO`	Attribute `value` is no longer read-only.	incompatible
		`QuantityRO`	Attribute `unit` is no longer read-only.	incompatible
		`QuantityRO`	Attribute `value` is no longer read-only.	incompatible
		`SalesPricingRO`	Attribute `price` is replaced by `undiscountedPrice`	incompatible	The line item price (single base price x quantity) w/o any discounts
			Attribute `discountedPrice` is replaced by `price`	incompatible	The line item price (single base price x quantity) w granted item value discounts
			Attribute `singleBasePrice` is replaced by `undiscountedSingleBasePrice`	incompatible	The base price of one (single base price / quantity) single item w/o any discounts
			Attribute `discountedSingleBasePrice` is replaced by `singleBasePrice`	incompatible	The base price of one item w/ granted item discounts broken down to one item
			Attribute `discountedSingleBasePriceRemainder` is replaced by `singleBasePriceRemainder`	incompatible	The remainder of the operation that calculates the `singleBasePrice`.
		`ShippingPricingRO`	Attribute `shippingTotal` is replaced by `undiscountedShippingTotal`	incompatible	The accumulated shipping costs of the line item w/o any shipping discounts.
		`TotalsRO`	Attribute `itemTotal` is replaced by `undiscountedItemTotal`	incompatible	The accumulated line item totals w/o any discounts
			Attribute `discountedItemTotal` is replaced by `itemTotal`	incompatible	The accumulated line item total w/ all granted item value discounts
			Attribute `shippingTotal` is replaced by `undiscountedShippingTotal`	incompatible	The accumulated shipping costs/charges w/o any discounts
			Attribute `discountedShippingTotal` is replaced by `shippingTotal`	incompatible	The accumulated shipping costs/charges w/ all granted shipping discounts
			New attribute `paymentCostsTotal`	compatible	Accumulated payment costs of the order
		`AddressRO`	New attribute `companyName1`	compatible	First part of addressee's company name
		`AddressRO`	New attribute `companyName2`	compatible	Second part of addressee's company name
		`TaxItemRO`	New attribute `taxId`	compatible	For future use
			New attribute `taxName`	compatible	For future use
			New record `ImpositionRO`	compatible	For future use
		`JurisdictionRO`	New attribute `value`	compatible	For future use
		`JurisdictionRO`	Attribute `level` is required now	incompatible
		`ImpositionRO`	New attribute `value`	compatible	For future use
		`ImpositionRO`	New attribute `type`	compatible	For future use

Storefront REST API

Address Check REST API

Version API Element Change Compatibility Comment

Version	API	Element	Change	Compatibility	Comment
7.10.40.4 7.10.38.21-LTS	Address Check REST API 1.1.0	Address	The read-only properties `externalId` and `externalUrn` have been added to the address resource object. This affects all address objects in the API. Increase the API version from 1.0.0 to 1.1.0	compatible

7.10.40.4

7.10.38.21-LTS

Address Check REST API 1.1.0

Address

The read-only properties externalId and externalUrn have been added to the address resource object. This affects all address objects in the API.

Increase the API version from 1.0.0 to 1.1.0

compatible

Authentication API

Version	API	Element	Change	Migration
7.10.24.1	authentication	path /logout	Value of path in UserTokenResource (no API) of endpoint '/logout' changed to 'token/logout'.	Adapt urls in client calls. Use 'token/logout' instead of 'token'.

Basket V0 REST API

Version API Element Change Compatibility Comment

Version	API	Element	Change	Compatibility	Comment
7.10.40.4 7.10.38.21-LTS	Basket REST API 0.2.0	Address	The read-only properties `externalId` and `externalUrn` have been added to the address resource object. This affects all address objects in the API. Increase the API version from 0.1.0 to 0.2.0	compatible

7.10.40.4

7.10.38.21-LTS

Basket REST API 0.2.0

Address

The read-only properties externalId and externalUrn have been added to the address resource object. This affects all address objects in the API.

Increase the API version from 0.1.0 to 0.2.0

compatible

Basket V1 REST API

In the Storefront Basket V1 REST APIs there are the following changes:

Get a stringent naming scheme (LineItemRO, LineItemTotalsRO, BasketTotalsRO).
Simplify handling of custom attributes (ExtensibleRO).

Version	API	Element	Change	Compatibility	Comment
7.10.7.3	Basket V1 (beta) Note This API is a beta version and still subject to changes.	`LineItemRO`	Attribute `price` is replaced by `undiscountedPrice` and has been moved to Element `LineItemPricingRO` (former `LineItemTotalsRO`).	incompatible	The line item price (single base price x quantity) w/o any discounts
			Attribute `discountedPrice` is replaced by `price` and has been moved to `LineItemPricingRO` (former `LineItemTotalsRO`).	incompatible	The line item price (single base price x quantity) w granted item value discounts
			Attribute `singleBasePrice`is replaced by `undiscountedSingleBasePrice` and has been moved to `LineItemPricingRO` (former `LineItemTotalsRO`).	incompatible	The base price of one (single base price / quantity) single item w/o any discounts
			Attribute `discountedSingleBasePrice` is replaced by `singleBasePrice` and has been moved to `LineItemPricingRO` (former `LineItemTotalsRO`).	incompatible	The base price of one item w/ granted item discounts broken down to one item
			Attribute `totals` is replaced by `pricing`.
		`LineItemTotalsRO`	Element has been renamed to `LineItemPricingRO`.	incompatible
		`LineItemTotalsRO`	Attribute `totals` has been replaced by `price`.
		`BasketTotalsRO`	Attribute `itemTotal` is replaced by `undiscountedItemTotal`.	incompatible	The accumulated line item totals w/o any discounts
			Attribute `discountedItemTotal` is replaced by `itemTotal`.	incompatible	The accumulated line item total w/ all granted item value discounts
			Attribute `shippingTotal` is replaced by `undiscountedShippingTotal`.	incompatible	The accumulated shipping costs/charges w/o any discounts
			Attribute `discountedShippingTotal` is replaced by `shippingTotal`.	incompatible	The accumulated shipping costs/charges w/ all granted shipping discounts
			Attribute `paymentCostTotal` is replaced by `paymentCostsTotal`.
		`ExtensibleRO` (and all inheriting elements: `AddressRO`, `BasketRO`, `LineItemRO`, `ShippingMethodRO`)	Method `ExtensibleRO::getAttributes() : Map<String, Collection<String>>` has been replaced by `ExtensibleRO::getAttributes() : Collection<AttributeRO<?>>`.	incompatible	Attributes are contained in the `data` section of JSON payload of related elements instead of the `includes` section.

Business Customer User List / User Item REST API

Storefront Business Customer User List / User Item REST API was extended:

Business Customer Users List resource GET method previously showed the current logged user. It was changed to list all actual users of the customer;
Added POST method to Business Customer Users List resource to create one or multiple new users for the customer;
Added DELETE method to Business Customer User Item resource to remove customer's user;
Altered PUT method of Business Customer User Item resource - previously it only allowed the current logged user to change their own attributes; now admin user can change values of other users which belong to the same customer.

Version	API	Element	Change	Compatibility
7.10.7.3	Business Customer User List / User Item	UserRO	New method getBirthdayDate() : Date	compatible
SMBCustomerUserRO	New methods: getPreferredInvoiceToAddressUrn() : String setPreferredInvoiceToAddressUrn(String) getPreferredShipToAddressUrn() : String setPreferredShipToAddressUrn(String)	compatible
New classes in app_sf_rest_smb cartridge	SMBCustomerUserROCollection UserLinkRO UserLinkROCollection	compatible

Version

API

Element

Change

Compatibility

Comment

7.10.7.3

Business Customer User List / User Item

UserRO

New method getBirthdayDate() : Date

compatible

SMBCustomerUserRO

New methods:

getPreferredInvoiceToAddressUrn() : String

setPreferredInvoiceToAddressUrn(String)

getPreferredShipToAddressUrn() : String

setPreferredShipToAddressUrn(String)

compatible

New classes in app_sf_rest_smb cartridge

SMBCustomerUserROCollection

UserLinkRO

UserLinkROCollection

compatible

CMS REST API

Version	API	Element	Change	Compatibility	Comment
7.10.19.2	CMS REST API		The REST API documentation was extended to explain the proper usage of personalized requests for the CMS REST API.	compatible
7.10.18.1	CMS REST API	PageTreeResource	Resource is introduced to expose the page hierarchy.	compatible

Configuration REST API

Version	API	Element	Change	Compatibility	Comment
7.10.40.4	Configuration V1 (beta)	ConfigurationRO	A new section "`marketing`" with new preference: "`newsletterSubscriptionEnabled`" has been added. { "data": { ... "marketing": { "id": "marketing", "newsletterSubscriptionEnabled": true }, ... } The flag is true when an e-mail marketing provider is set up, so that the newsletter subscription feature is enabled and can be used.	compatible
7.10.20.0	Configuration V1 (beta) Note This API is a beta version and still subject to changes.	ConfigurationRO	Change of the response data structure from list to map representation. Payload before the change: { "data": [ { "applicationType": "intershop.B2CResponsive", "default": true, "id": "application", "urlIdentifier": "-" },... ] } Payload after the change: { "data": { "application": { "applicationType": "intershop.B2CResponsive", "default": true, "id": "application", "urlIdentifier": "-" },... } }	incompatible

Cost Center REST API

Version	API	Element	Change	Compatibility	Comment
7.10.38.15-LTS	Cost Center	CostCenterUserRO	New field "active" which indicates whether the user is active or not.	compatible

Customer REST API

Version API Element Change Compatibility Comment

Version	API	Element	Change	Compatibility	Comment
7.10.40.4 7.10.38.21-LTS	Customer REST API 1.2.0	Address	The read-only properties `externalId` and `externalUrn` have been added to the address resource object. This affects all address objects in the API. Increase the API version from 1.1.0 to 1.2.0	compatible
7.10.15.0	customer/{customerKey}/credentials/password	CustomerPasswordRO	New mandatory attribute currentPassword.	compatible	In order to keep the old behavior it is possible to make currentPassword optional by setting"PasswordUpdateSkipOldPasswordValidation" preference to "true".
		CredentialsHandler	Signature of method validatePassword changed from validatePassword(UserBO userBO, String password) to validatePassword(UserBO userBO, CustomerPasswordRO passwordRO).	incompatible

7.10.40.4

7.10.38.21-LTS

Customer REST API 1.2.0

Address

The read-only properties externalId and externalUrn have been added to the address resource object. This affects all address objects in the API.

Increase the API version from 1.1.0 to 1.2.0

compatible

7.10.15.0

customer/{customerKey}/credentials/password

CustomerPasswordRO

New mandatory attribute currentPassword.

compatible

In order to keep the old behavior it is possible to make currentPassword optional by setting"PasswordUpdateSkipOldPasswordValidation" preference to "true".

CredentialsHandler Signature of method validatePassword changed from validatePassword(UserBO userBO, String password) to validatePassword(UserBO userBO, CustomerPasswordRO passwordRO). incompatible

Notification REST API

Version	API	Element	Change	Compatibility	Comment
7.10.39	Notifications	CustomerProductNotificationResource CustomerProductNotificationsResource	"Deprecated" annotations are removed from API calls	compatible
7.10.19	Notifications	CustomerProductNotificationResource CustomerProductNotificationsResource	API calls were falsely set to deprecated	compatible

Version

API

Element

Change

Compatibility

Comment

7.10.39

Notifications

CustomerProductNotificationResource

CustomerProductNotificationsResource

"Deprecated" annotations are removed from API calls

compatible

7.10.19

Notifications

CustomerProductNotificationResource

CustomerProductNotificationsResource

API calls were falsely set to deprecated

compatible

Order V0 REST API

Version API Element Change Compatibility Comment

Version	API	Element	Change	Compatibility	Comment
7.10.40.4 7.10.38.21-LTS	Order REST API 0.2.0	Address	The read-only properties `externalId` and `externalUrn` have been added to the address resource object. This affects all address objects in the API. Increase the API version from 0.1.0 to 0.2.0	compatible

7.10.40.4

7.10.38.21-LTS

Order REST API 0.2.0

Address

The read-only properties externalId and externalUrn have been added to the address resource object. This affects all address objects in the API.

Increase the API version from 0.1.0 to 0.2.0

compatible

Order V1 REST API

Version	API	Element	Change	Compatibility	Comment
7.10.41.8-LTS	Order REST API 1.2.3	Totals	Attribute `tax` of `itemTotals` was declared but not offered. Now the value is handed out.	compatible

Product and Category REST API

Version	API	Element	Change	Compatibility	Comment
7.10.40	Product	ProductListResource	API version was increased to 1.7 `endOfLife` and lastOrderDate were added as requestable attributes for the `attrs` parameter	compatible	Example: /products?attrs=endOfLife,lastOrderDate
7.10.40	Product	ProductsResource	Now, the following extended attributes are supported: customAttributes,reviews,shippingMethods,averageRating,roundedAverageRating	compatible	Example: /products/12345?attrs=customAttributes,reviews,shippingMethods,averageRating,roundedAverageRating
7.10.39	Product and Category		API version was increased to 1.6	compatible	See details in the following lines
7.10.39	Product	ProductListResource	`maxOrderQuantity` and `stepQuantity` were added as requestable attributes for the `attrs` parameter	compatible	Example: /products?attrs=minOrderQuantity,maxOrderQuantity,stepQuantity
7.10.39	Product	ProductsResource	The `seoAttributes` element was previously always returned when the `attrs` parameter was used. Now it is only returned when the `attrs` parameter is used and the element is requested explicitly.	incompatible	Example: /products/12345?attrs=seoAttributes
7.10.39	Category	CategoryRO	The "Show in Menu" flag of a category was previously only returned in the REST response when it was "true". Now it is also returned if it is "false".	compatible
7.10.38.9-LTS	Product	ProductsResource	Default categories that are unavailable on the REST interface are no longer included in REST responses.	compatible	The defaultCategory property is omitted and not included in the response. The PWA treats this attribute as optional. Other UIs may need to be updated.
7.10.38.9-LTS	Product	ProductsResource	SEOMetaAttributes of the product resource returned in a REST call are by default no longer provided by the DetermineMetaTags pipeline.	compatible	The pipeline has been replaced by the java implementation in ProductSEOMetaAttributesHandlerImpl. To return to the pipeline implementation, use PipelineBasedProductSEOMetaAttributesHandlerImpl instead.
7.10.38.9-LTS	Product	ProductListResource	A configurable limit for returned products per request was added. If a higher amount value is used as a query parameter (default limit: 200), a 400 Bad Request Error will be returned.	compatible	Follow-up to the change below: If absolutely necessary, you can adjust the limit using the property `intershop.rest.maxProductAmount` to restore API function.
7.10.38.9-LTS	Product	ProductListResource	Limit of 200 for returned products per request added. If a higher value is used as a query parameter "amount", an exception is thrown.	incompatible	This is a security measure to avoid unnecessarily high load on the ICM. For PWAs with paging, this is not an issue.
7.10.38.9-LTS	Product	ProductsResource ProductListResource	Authenticated calls for the resources `ProductsResource` and `ProductListResource` will now check if the provided `spgid` matrix parameter matches with the user. When a `spgid` is provided, and there is a mismatch, a 400 Bad Request Error will be returned.	incompatible	Previously, it was only checked whether a `spgid` was specified or not. This resulted in incorrectly cached prices, e.g., when a default `spgid` such as "undefined" was used in the request. The `spgid` of a user can be requested via the PersonalizationResource. If no `spgid` is provided, the request will be handled as an anonymous request as before this change.
7.10.38.9-LTS	Product	ProductListResource	In case no search index is found, error code 503 is returned.	compatible	Removed fallback to database search. If the database search has been customized in your project, you can simply switch back to the old product handler that still uses the old pipelines and contains the database fallback.
7.10.38.9-LTS	Product	ProductHandler(Impl)	ProductHandlerImpl was deprecated, a new implementation was added In ProductHandler `getProducts` and `getProductsBySimpleSearch` were replaced with more meaningful methods `/products?productFilter=...` and `/categories/<...>/products?productFilter=...` now works consistently	compatible	see Guide - 7.10.38.9 Rest API ProductHandler Rework
7.10.35.1	Product	FilterCollectionRO	In case no search index is found, error code 503 is returned, instead of "500 server error".	compatible
7.10.27.0	Product	ProductListResource	The `inStock` attribute returns data from the inventory service now, instead of data maintained in ICM.	incompatible	Previously the `inStock` and `availability` fields both returned the value of the "in stock" checkbox of a product in the ICM. This was wrong and did not match the documentation. Now the behavior is corrected. In case the `inStock` attribute was previously used, an adjustment is required: `inStock` returns inventory data from the inventory service (boolean; empty in case there is no active inventory service) `availableStock` returns the stock level of a product from a quantity-based inventory service `availability` returns the value of the "in stock" as maintained in the ICM
7.10.27.0	Product / Promotion	ProductPromotionResource	Improved caching for resource "/products/<sku>/promotions"	compatible	The result list of promotions is now personally cached; for personalized promotions a "spgid" matrix parameter is mandatory, either as part of "products" or "promotions". The caching time now depends on the end dates of involved promotions (valid until first promotion becomes invalid). If "spgid" is missing for authorized requests the result for anonymous users is returned.
7.10.26.2	Product	ProductListResource	Parameter `returnSortKeys` now returns an additional field `sortableAttributes`.	compatible	The parameter `returnSortKeys`, when true, will return a list of sort keys for the search query in the field `sortKeys`. Now, an additional field `sortableAttributes` is returned as well, with more detailed information on the sort keys, such as direction and display name.
7.10.23.0	Product	ProductsResource ProductFiltersResource	New query parameter `MasterSKU` added	compatible	`MasterSKU` can now be indexed in the search index, similar to `MasterUUID`. This is needed so `MasterSKU` can be used in the REST API, e.g. to filter /products and /productfilters for a given variation master. (The REST API only handles skus, not UUIDs.) Add new attribute "MasterSKU" to the index, with the same settings as "MasterUUID". Recommendation: Keep the name "MasterSKU". If not, make a note of the new defined name so you can use it later in the REST API - this is the name of the query parameter. Rebuild the search index. Now you can use the “MasterSKU” query parameter as described in the REST API documentation.
7.10.23.0	Product	ProductsResource ProductFiltersResource	if configured: new sort order of results	compatible	Variation products on variation master pages, as well as in the REST API (/products?MasterSKU=<sku>) can now be sorted as defined in the backoffice, if no other sorting is specified. This requires configuration of the search index. create new index attribute name: VariationPosition data provider: ProductPO data type: Double rebuild search index Note: If this is not done, the sorting remains as it is right now.
7.10.23.0	Product	ProductListResource	Support for multiple comma-separated IDs for parameter `attributeGroup` New field `attributeGroups` in result if multipe IDs were given.	compatible	If multiple IDs are given, then in the result, the field `attributeGroup` will be empty, and `attributeGroups` is used.
7.10.23.0	Product	AttributeGroupRO	New field `displayName` added	compatible
7.10.21	Product	SearchIndexFilterResource SearchIndexFilterListResource	Resources are now deprecated.	compatible
7.10.21	Product	ProductFiltersResource	Resource is introduced.	compatible	A new resource /productfilters was introduced for the filter REST API. It replaces the (now deprecated) /filters resource.
7.10.21.0	Product	ProductRO	New field `supplierSKU` added.	compatible
7.10.18.0	Category	CategoryRO	Category endpoint now support category references as a category id, replacing the previous `categoryRef` query parameter. Format: `/categories/<category id or ref>`	incompatible
7.10.17.0	Product	ProductRO	New query parameter `extended` added New field `variationAttributeValuesExtended` added	compatible
7.10.17.0	Product	AttachmentRO	New field `link` added	compatible
7.10.17.0	Category and CategoryList	CategoryRO	New query parameter `omitHasOnlineProducts` added	compatible
7.10.15.2	Product List	ProductRO	New attribute in attrs section `retailSet`	compatible
7.10.15.2	Category and CategoryList	CategoryRO	Add functionality for caching the /categories call	compatible
7.10.10.2	Product / Product Line Item	DefaultCategoryRO	Extend appendProductSKUToPath(String path, ProductBO product) to show default category	compatible
7.10.9.0	Product and Category List	LinkRO	New attribute in attrs section: `packingUnit`	compatible
7.10.5.4	Product List / Product Line Item	LinkRO	New attribute in attrs section: `availableStock`	compatible
7.10.5.3	Product List	AttributeGroupRO	New method getRESTAvailableAttributeGroups(ProductBO product)	compatible	Related: Adding flag in the backoffice if attribute groups should be available in REST.
7.10.5.3	Product and Category List	LinkRO	New attributes in attrs section: `minOrderQuantity` and `inStock`	compatible

Product Price REST API

Version	API	Element	Change	Compatibility	Comment
7.10.38.17-LTS	Product Price V1 Note Due to the gained product maturity, the beta status of this API was lifted.	ProductPriceResource	In order to fully support address-specific prices (gross prices based on address-specific taxes) it is now possible to pass "shipFromAddress" and "shipToAddress" as additional parameters. Both parameters could either be an address uuid or URN. The parameters are optional. If they are missing and there is no preferred shipping address for a certain customer, the default tax rate is used to calculate gross prices (if requested).	compatible (extend API)
7.10.38.9-LTS	Product Price V1 (beta) Note This API is a beta version and still subject to changes.	ProductPriceResource	Now RetailSets and Variation Master products are fully supported: Instead of List and Sale Price the following Prices (net and/or gross) are returned: RetailSets: Min list and/or sale price Summed up list and/or sale price Variation Master: Min list and/or sale price Max list and/or sale price	compatible (extend API)	Still not supported: Warranties
7.10.32.0-LTS	Product Price V1 (beta) Note This API is a beta version and still subject to changes.	ProductPriceResource	A new Product Price REST API has been implemented which allows an uncached access of product prices including scaled prices. The following features are supported: B2C and B2B customer-specific prices prices for multiple products in one request net and/or gross prices in one request (configurable via query parameter) list and/or sale prices in one request (configurable via query parameter) scaled prices included (fixed price or percentage discount)	compatible (new API)	Not supported: Retail Sets Variation Master Warranties

Version

API

Element

Change

Compatibility

Comment

7.10.38.17-LTS

Product Price V1

Note

Due to the gained product maturity, the beta status of this API was lifted.

ProductPriceResource

In order to fully support address-specific prices (gross prices based on address-specific taxes) it is now possible to pass "shipFromAddress" and "shipToAddress" as additional parameters. Both parameters could either be an address uuid or URN.

The parameters are optional. If they are missing and there is no preferred shipping address for a certain customer, the default tax rate is used to calculate gross prices (if requested).

compatible

(extend API)

7.10.38.9-LTS

Product Price V1 (beta)

Note

This API is a beta version and still subject to changes.

ProductPriceResource

Now RetailSets and Variation Master products are fully supported:
Instead of List and Sale Price the following Prices (net and/or gross) are returned:

RetailSets:

Min list and/or sale price
Summed up list and/or sale price

Variation Master:

Min list and/or sale price
Max list and/or sale price

compatible

(extend API)

Still not supported:

Warranties

7.10.32.0-LTS

Product Price V1 (beta)

Note

This API is a beta version and still subject to changes.

ProductPriceResource

A new Product Price REST API has been implemented which allows an uncached access of product prices including scaled prices.

The following features are supported:

B2C and B2B
customer-specific prices
prices for multiple products in one request
net and/or gross prices in one request (configurable via query parameter)
list and/or sale prices in one request (configurable via query parameter)
scaled prices included (fixed price or percentage discount)

compatible

(new API)

Not supported:

Retail Sets
Variation Master
Warranties

Promotion REST API

Version	API	Element	Change	Compatibility	Comment
7.10.35.1	Promotion	PromotionResource	Improved caching for resource "/promotions/<promotion-id>"	compatible	The promotion details are now also personally cached like the promotion lists. Details for a promotion can only be retrieved when the promotion is accessible to the requested user.
7.10.27.0	Promotion	PromotionResource	Improved caching for resource "/promotions"	compatible	The result list of promotions is now personally cached; for personalized promotions a "spgid" matrix parameter is mandatory, either as part of "products" or "promotions". The caching time now depends on the end dates of involved promotions (valid until first promotion becomes invalid). If "spgid" is missing for authorized requests the result for anonymous users is returned.

Rating & Review REST API

Version API Element Change Compatibility Comment

7.10.38.14-LTS

Rating & Review

ReviewItemResource (ReviewRO)

Version	API	Element	Change	Compatibility	Comment
7.10.38.14-LTS	Rating & Review	ReviewItemResource (ReviewRO)	The item details of a review now contain the boolean attribute `own` which reflects whether the review was created by the currently authenticated user.	compatible (extend API)	`own` flag was only available in the list so far
7.10.38.14-LTS	Rating & Review	ReviewItemResource (ReviewRO)	The item details of a review now contain a new processable "statusCode". It reflects the status of the review. Possible values are "NEW", "APPROVED", "REJECTED". The statusCode "APPROVED" is also used for reviews that are immediately visible without approval.	compatible (extend API)	Field "status" remains unchanged.
7.10.38.14-LTS	Rating & Review	ReviewListResource	When new reviews are created, now title and content of a review are checked for profanity.	no API change

The item details of a review now contain the boolean attribute own which reflects whether the review was created by the currently authenticated user.

compatible

(extend API)

own flag was only available in the list so far

7.10.38.14-LTS

Rating & Review

ReviewItemResource (ReviewRO)

The item details of a review now contain a new processable "statusCode". It reflects the status of the review.
Possible values are "NEW", "APPROVED", "REJECTED". The statusCode "APPROVED" is also used for reviews that are immediately visible without approval.

compatible

(extend API)

Field "status" remains unchanged.

7.10.38.14-LTS

Rating & Review

ReviewListResource

When new reviews are created, now title and content of a review are checked for profanity.

no API change

Recurring Order (Subscriptions) REST API

Version API Element Change Compatibility Comment

Version	API	Element	Change	Compatibility	Comment
7.10.40.4 7.10.38.21-LTS	Recurring Order (Subscriptions) REST API 1.1.0	Address	The read-only properties `externalId` and `externalUrn` have been added to the address resource object. This affects all address objects in the API.	compatible

7.10.40.4

7.10.38.21-LTS

Recurring Order (Subscriptions) REST API 1.1.0

Address

The read-only properties externalId and externalUrn have been added to the address resource object. This affects all address objects in the API.

compatible

Requisition Approval REST API

Version	API	Element	Change	Compatibility	Comment
7.10.38.15-LTS	/customers/{CustomerKey}/users/{CustomerItemUserKey}/requisitions/{RequisitionKey}	RequisitionRO	New field "systemRejectErrors" which contains the reasons for system rejection of a requisition	compatible
7.10.36.0	/customers/{CustomerKey}/users/{CustomerItemUserKey}/requisitions/{RequisitionKey}	RequisitionRO	New field "approvalStatuses" which contains all already handled Approval Steps systemRejected is now part of the RequisitionRO	compatible	Should be used from RequisitionRO, instead of RequisitionRO.approvalStatus from now on
7.10.25.0	/customers/{CustomerKey}/users/{CustomerItemUserKey}/requisitions/{RequisitionKey}	ApprovalStatusRO	field "status" which was the status code before is now stored in field "statusCode" and the field "status" now contains a localized status text
7.10.25.0	/customers/{CustomerKey}/users/{CustomerItemUserKey}/requisitions/{RequisitionKey}	ApprovalStatusChangeRO	field "status" was renamed to "statusCode"

Security REST API

Version	API	Element	Change	Compatibility	Comment
7.10.15.0	security	password	Added new sub-resource "password" allowing to set new password - part of the "Forgot Password" feature. New REST resource com.intershop.sellside.rest.common.capi.resource.credentials.PasswordResetResource with one POST method resetPassword. New resource object com.intershop.sellside.rest.common.capi.resourceobject.PasswordResetRO New interface com.intershop.sellside.rest.common.capi.resource.credentials.handler.PasswordResetHandler	compatible
	security	reminder	Changed PasswordReminderResource to require security question answer, firstName and lastName only in case Security Question feature is activated.	compatible

Version

API

Element

Change

Compatibility

Comment

7.10.15.0

security

password

Added new sub-resource "password" allowing to set new password - part of the "Forgot Password" feature.

New REST resource com.intershop.sellside.rest.common.capi.resource.credentials.PasswordResetResource with one POST method resetPassword.

New resource object com.intershop.sellside.rest.common.capi.resourceobject.PasswordResetRO

New interface com.intershop.sellside.rest.common.capi.resource.credentials.handler.PasswordResetHandler

compatible

security

reminder

Changed PasswordReminderResource to require security question answer, firstName and lastName only in case Security Question feature is activated.

compatible

Wish List REST API

Version API Element Change Compatibility Comment

Version	API	Element	Change	Compatibility	Comment
7.10.38.27-LTS 7.10.40.4	Wish List REST API 1.1.0	PublicWishlistListResource	The maximum number of public wish lists returned by the `GET /wishlists` request has been limited. See the modified API documentation for details. The API version has been increased from 1.0.0 to 1.1.0.	compatible

7.10.38.27-LTS

7.10.40.4

Wish List REST API 1.1.0

PublicWishlistListResource

The maximum number of public wish lists returned by the GET /wishlists request has been limited. See the modified API documentation for details.

The API version has been increased from 1.0.0 to 1.1.0.

compatible

Additional Modules and Connectors

Contact Center REST API

Version API Element Change Compatibility Comment

7.10.38.14-LTS

User Details

UserResource (UserRO)

Version	API	Element	Change	Compatibility	Comment
7.10.38.14-LTS	User Details	UserResource (UserRO)	The details of a user (Contact Center Account Representative) now contain the string attribute `login` in addition to `firstname` and `lastname`.	compatible (extend API)
7.10.38.28-LTS / 7.10.41.0	Application	ApplicationResource (ApplicationRO)	The field `storeFrontAppUrl` contains the URL of the store front application used by the Co-Browse-Feature. Now it either refers to the standard Co-Browse pipeline of the Responsive Starter Store or the Co-Browse route of the PWA, if an external URL is configured in Intershop Commerce Management. An additional attribute `externalApplication` determines whether the `storeFrontAppUrl` points to an external application like the PWA (`true`) or to an internal application, i.e. the Responsive Starter Store (`false`).	compatible (extend API)

The details of a user (Contact Center Account Representative) now contain the string attribute login in addition to firstname and lastname.

compatible

(extend API)

7.10.38.28-LTS / 7.10.41.0

Application

ApplicationResource (ApplicationRO)

The field storeFrontAppUrl contains the URL of the store front application used by the Co-Browse-Feature. Now it either refers to the standard Co-Browse pipeline of the Responsive Starter Store or the Co-Browse route of the PWA, if an external URL is configured in Intershop Commerce Management.

An additional attribute externalApplication determines whether the storeFrontAppUrl points to an external application like the PWA (true) or to an internal application, i.e. the Responsive Starter Store (false).

compatible

(extend API)

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.

Table of Contents

Intershop Commerce Management REST API

Storefront REST API

Address Check REST API

Authentication API

Basket V0 REST API

Basket V1 REST API

Business Customer User List / User Item REST API

CMS REST API

Configuration REST API

Cost Center REST API

Customer REST API

Notification REST API

Order V0 REST API

Order V1 REST API

Product and Category REST API

Product Price REST API

Promotion REST API

Rating & Review REST API

Recurring Order (Subscriptions) REST API

Requisition Approval REST API

Security REST API

Wish List REST API

Additional Modules and Connectors

Contact Center REST API