Related Documents
Document Properties
KbidT27770
Last Modified23-Jun-2020
Added to KB20-Jul-2016
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Get product data category with product price based on a address


Note

Starting with 7.10 our REST API is documented using Redoc accessible at docs.intershop.com.

URI

/categories/<cat_ID>/products/<sku>?basketId=aBasketId

Http Method

GET

Short Description

Gets product data with prices based on the given addresses or the basket address

Query Parameters

basketId=<basketID>

invoiceToAddressId=<addressID>

shipToAddressId=<addressID>

shipFromAddressId=<addressID>

Example Requests

/categories/Computers/Notebooks/products/29556141?basketId=9joKDgAXE_kAAAFRKAQzzFkp&invoiceToAddressId=1A0KDgAXp68AAAFQl5wyHPKJ

HTTP Status Codes

200 OK

404 Not found

Description

The request retrieves price(s) of a product based on given addresses or the given baskets addresses.

  1. The given address (invoiceTo, shipTo, shipFrom) are taken
  2. If no shipTo/invoiceTo address -> then take addresses from basket
  3. If there is no basket -> try to retrieve the basket from the current user
  4. If still no invoiceTo address -> then used current users getPreferredBillingAddressBO
  5. If still no shipTo address -> then used current users getPreferredShippingAddressBO

The parameter 'basketId', 'invoiceToAddressId', 'shipToAddressId', 'shipFromAddressId', 'view' and 'attrs' can be combined.

See REST API - Get product data category (until 7.8)and the second example.

Cartridge

app_sf_rest
ApplicationB2C Web Shop, SMB Web Shop

Product Version

7.7

Product To Version

 
Status

final

JSON

Request data format

application/json

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.resource.ProductResource
com.intershop.sellside.rest.b2c.capi.resourceobject.ProductRO

Response data example

See JSON response example at page: REST API - Get product data category (until 7.8)

XML

Request data format

application/json

Request related java object

n/a

Requestdata example

n/a

Response data format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.ProductResource
com.intershop.sellside.rest.b2c.capi.resourceobject.ProductRO

Response data example

See XML response example at page: REST API - Get product data category.

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