REST API - Get personalized product data

Personal Library

https://support.intershop.com/kb/2804R2

Note

Starting with Intershop 7.10 our REST API is provided in the Open API 3.0 format, see Reference - Intershop Commerce Management 7.10 REST API.

URI	/products;spgid=<personalization_group_id>/<sku>
Http Method	GET
Short Description	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.
Query Parameters	For available parameters refer to: REST API - Get product data (until 7.8) REST API - Get selected product attributes REST API - Get product attributes of view REST API - Get product data with price based on a address
Example Requests	/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/9438012, /products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/9438012?attrs=shortDescription,longDescription
HTTP Status Codes	200 OK 404 Not found
Description	Equivalent to /products/<sku>, but in addition the "spgid" matrix parameter is provided and used for personalized caching. See REST API - Get product data (until 7.8), REST API - Get selected product attributes, REST API - Get product attributes of view and REST API - Get product data with price based on a address for different query parameters on the /products/<sku> resource. The matrix parameter "spgid" is optional and it stands for personalization Group Based Caching. If not provided, the Web Adapter will NOT cache the response from the Rest call. Response for anonymous customers is NOT cached, even if the "spgid" parameter is provided. This means that anonymous customers always get not cached response and there is NO need to provide "spgid" if this rest call is executed without authorization. If "spgid" is provided in the URI for an unregistered customer (e.g. /products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/M7972533), then this "faulty" spgid is removed from the result URIs (e.g. /products/GiftWrapPinkFlowers is an URI to access an available gift wrap; /products/M7972533/variations is an URI to access the list of variations of a master). Response for the currently logged in customer is cached only if the "spgid" parameter is provided and it contains a valid personalization group ID as a value. Usually this personalization group is retrieved from the session of the current user. If "spgid" is not provided in the URI for a logged-in customer (e.g. /products/M7972533), then the response is NOT cached by the Web Adapter but the result URIs contain this "spgid" parameter (e.g. /products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/GiftWrapPinkFlowers is an URI to access an available gift wrap; /products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/M7972533/variations is an URI to access the list of variations of a master) in order to be cached when a call is performed based on the generated URIs. If the "spgid" is not valid then an empty resource is returned.
Cartridge	app_sf_rest
Application	B2C Web Shop, B2C Responsive Shop, SMB Web Shop, SMB Responsive Shop

Product Version	7.8
Product To Version
Status	New Labels

JSON

Request data format	n.a.
Request related java object	n/a
Request data example	n/a
Response data format	application/json
Response related java object	com.intershop.sellside.rest.common.capi.resourceobject.ProductRO
Response data example	Anonymous customer: /products/11089966 ... "availableGiftWraps": [ { "type": "Link", "uri": "inSPIRED-inTRONICS-Site/-/products/GiftWrapNature", "title": "Gift Wrap Nature", "description": "Wrapping paper with ornamental pattern." }, ... ] ... Anonymous customer: /products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/11089966 ... "availableGiftWraps": [ { "type": "Link", "uri": "inSPIRED-inTRONICS-Site/-/products/GiftWrapNature", "title": "Gift Wrap Nature", "description": "Wrapping paper with ornamental pattern." }, ... ] ... Authenticated customer: /products/11089966 ... "availableGiftWraps": [ { "type": "Link", "uri": "inSPIRED-inTRONICS-Site/-/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/GiftWrapNature", "title": "Gift Wrap Nature", "description": "Wrapping paper with ornamental pattern." }, ... ] ... Authenticated customer: /products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/11089966 ... "availableGiftWraps": [ { "type": "Link", "uri": "inSPIRED-inTRONICS-Site/-/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/GiftWrapNature", "title": "Gift Wrap Nature", "description": "Wrapping paper with ornamental pattern." }, ... ] ...

XML

Request data format	n.a.
Request related java object	n/a
Request data example	n/a
Response data format	text/xml
Response related java object	com.intershop.sellside.rest.common.capi.resourceobject.ProductRO
Response data example	Anonymous customer: /products/11089966 ... <availableGiftWraps> <availableGiftWraps type="Link"> <description>Wrapping paper with ornamental pattern.</description> <title>Gift Wrap Nature</title> <uri>inSPIRED-inTRONICS-Site/-/products/GiftWrapNature</uri> </availableGiftWraps> ... </availableGiftWraps> ... Anonymous customer: /products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/11089966 ... <availableGiftWraps> <availableGiftWraps type="Link"> <description>Wrapping paper with ornamental pattern.</description> <title>Gift Wrap Nature</title> <uri>inSPIRED-inTRONICS-Site/-/products/GiftWrapNature</uri> </availableGiftWraps> ... </availableGiftWraps> ... Authenticated customer: /products/11089966 ... <availableGiftWraps> <availableGiftWraps type="Link"> <description>Wrapping paper with ornamental pattern.</description> <title>Gift Wrap Nature</title> <uri>inSPIRED-inTRONICS-Site/-/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/GiftWrapNature</uri> </availableGiftWraps> ... </availableGiftWraps> ... Authenticated customer: /products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/11089966 ... <availableGiftWraps> <availableGiftWraps type="Link"> <description>Wrapping paper with ornamental pattern.</description> <title>Gift Wrap Nature</title> <uri>inSPIRED-inTRONICS-Site/-/products;spgid=2.OQ5GnFf7g000TpV0cVgJST0000/GiftWrapNature</uri> </availableGiftWraps> ... </availableGiftWraps> ...

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.