The Intershop Customer Support website uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Further information on privacy can be found in the Intershop Privacy Policy and Legal Notice.
OK
Related Documents
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
REST API - Get list of products with pageable category
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
●
Document Properties
Kbid
X25153
Last Modified
26-Nov-2018
Added to KB
17-Sep-2013
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10
⋮

REST API - Get list of products with pageable category

https://support.intershop.com/kb/X25153
Share this document


Note

Starting with 7.10 our REST API is documented using Swagger notation accessible at developer.cloud.intershop.com.

URI

/categories/<catID>/products?pageable=<pageableID>

Http Method

GET

Short Description

Get list of products of (sub-) category and use pageable IDs

Query Parameters

Parameter:

  • pageable - the name of previously generated pageable of retrieved products. Contains retrieved product list for a specific REST call.

Example Requests

 

HTTP Status Codes

200 OK
404 Not found

Description

The result described in REST - categories - GET - Get list of products may include a pageable ID.

The pageable ID may by used in subsequent requests. The use of pageable ID reduces server response time.
If the pageable ID was not found on the server the provided pageable ID will be ignored.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version

 

Status

final

 

JSON

Request Data Format

Request related java object

n/a

Request Example

n/a

Response Data Format

application/json

Response related java object

com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
com.intershop.component.rest.capi.resourceobject.LinkRO

Response Example

Create the pageable: 

/categories/Cameras-Camcorders/products?amount=2&offset=2

{
    "pageable": "WrIKDACwCiUAAAFBTK2PZO9e",
    "total": 19,
    "offset": 2,
    "amount": 2,
    "elements": [
        {
            "type": "Link",
            "description": "Insurance against breakdown. Warranty period: 3 years.",
            "title": "3-year LED TV Support",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/3YLEDTVSUP"
        },
        {
            "type": "Link",
            "description": "120GB S510 SATA III",
            "title": "A-DATA 120GB S510",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/11089966"
        }
    ],
    "type": "ResourceCollection",
    "name": "products"
}

Use the pageable:
/categories/Cameras-Camcorders?pageable=WrIKDACwCiUAAAFBTK2PZO9e

{
    "pageable": "WrIKDACwCiUAAAFBTK2PZO9e",
    "elements": [
        {
            "type": "Link",
            "description": "Insurance against breakdown. Warranty period: 1 year.",
            "title": "1-year LED TV Support",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/1YLEDTVSUP"
        },
        {
            "type": "Link",
            "description": "Insurance against breakdown. Warranty period: 2 years.",
            "title": "2-year LED TV Support",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/2YLEDTVSUP"
        },
        {
            "type": "Link",
            "description": "Insurance against breakdown. Warranty period: 3 years.",
            "title": "3-year LED TV Support",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/3YLEDTVSUP"
        },
        {
            "type": "Link",
            "description": "120GB S510 SATA III",
            "title": "A-DATA 120GB S510",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/11089966"
        },
        {
            "type": "Link",
            "description": "128GB S599, 6.35 cm (2.5 \") SATA II, 1500G, 68g, Black",
            "title": "A-DATA 128GB S599",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/5930238"
        },
        {
            "type": "Link",
            "description": "S599 128GB Notebook Package SSD, 6.35 cm (2.5 \") SATA II, 1500G, 68g, Black",
            "title": "A-DATA 128GB S599",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/6830681"
        },
        {
            "type": "Link",
            "description": "16GB C003, USB 2,0, 10g, Blue",
            "title": "A-DATA 16GB C003",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/5079739"
        },
        {
            "type": "Link",
            "description": "16GB C003, USB 2,0, 10g, Red",
            "title": "A-DATA 16GB C003",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/5079721"
        },
        {
            "type": "Link",
            "description": "16GB C008, 10g, White/Blue",
            "title": "A-DATA 16GB C008",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/6946439"
        },
        {
            "type": "Link",
            "description": "16GB C008, 10g, Black/Red",
            "title": "A-DATA 16GB C008",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/6946438"
        },
        {
            "type": "Link",
            "description": "16GB C906m USB 2.0, 9g, White",
            "title": "A-DATA 16GB C906",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/5079756"
        },
        {
            "type": "Link",
            "description": "16GB C906, USB 2.0, 9g, Black",
            "title": "A-DATA 16GB C906",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/5079747"
        },
        {
            "type": "Link",
            "description": "S101 - 16GB, USB 2.0, 4g, Black",
            "title": "A-DATA 16GB S101",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/7415678"
        },
        {
            "type": "Link",
            "description": "16GB S102, USB 3.0, 15g, Read/Write - 68/18mb/sec, Titanium grey",
            "title": "A-DATA 16GB S102",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/7041208"
        },
        {
            "type": "Link",
            "description": "16GB SDHC Class 10",
            "title": "A-DATA 16GB SDHC Class 10",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/3596471"
        },
        {
            "type": "Link",
            "description": "1TB CH94, 6.35 cm (2.5 \") , USB 2.0, 210g, Black",
            "title": "A-DATA CH94 Portable 1TB",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/M7972533"
        },
        {
            "type": "Link",
            "description": "Retail Set: Benq T850 Red and Dicota CamPocket Zoom ",
            "title": "Benq T850 Red + Dicota CamPocket Zoom",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/M1610689"
        },
        {
            "type": "Link",
            "description": "Product Bundle: Canon EOS 5D, Canon EF 50mm f/1.8 II and Photoshop CS5.5 ",
            "title": "Canon EOS 5D Mark II, body + Canon EF 50mm f/1.8 II + Adobe Photoshop CS5 Extended, Win, Retail, DE",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/M1718663"
        },
        {
            "type": "Link",
            "description": "FRITZ!Box Fon WLAN 7170 Annex A",
            "title": "Product",
            "uri": "PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/859910"
        }
    ],
    "type": "ResourceCollection",
    "name": "products"
}

XML

XML Request Data Format

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
com.intershop.component.rest.capi.resourceobject.LinkRO

XML Response Example

Create the pageable: 

/categories/Cameras-Camcorders/products?amount=2&offset=2

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="products" type="ResourceCollection">
    <amount>2</amount>
    <elements>
        <Link type="Link">
            <description>Insurance against breakdown. Warranty period: 3 years.</description>
            <title>3-year LED TV Support</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/3YLEDTVSUP</uri>
        </Link>
        <Link type="Link">
            <description>120GB S510 SATA III</description>
            <title>A-DATA 120GB S510</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/11089966</uri>
        </Link>
    </elements>
    <offset>2</offset>
    <pageable>WrIKDACwCiUAAAFBTK2PZO9e</pageable>
    <total>19</total>
</ResourceCollection>

Use the pageable:

/categories/Cameras-Camcorders/products?pageable=WrIKDACwCiUAAAFBTK2PZO9e

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="products" type="ResourceCollection">
    <elements>
        <Link type="Link">
            <description>Insurance against breakdown. Warranty period: 1 year.</description>
            <title>1-year LED TV Support</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/1YLEDTVSUP</uri>
        </Link>
        <Link type="Link">
            <description>Insurance against breakdown. Warranty period: 2 years.</description>
            <title>2-year LED TV Support</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/2YLEDTVSUP</uri>
        </Link>
        <Link type="Link">
            <description>Insurance against breakdown. Warranty period: 3 years.</description>
            <title>3-year LED TV Support</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/3YLEDTVSUP</uri>
        </Link>
        <Link type="Link">
            <description>120GB S510 SATA III</description>
            <title>A-DATA 120GB S510</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/11089966</uri>
        </Link>
        <Link type="Link">
            <description>128GB S599, 6.35 cm (2.5 &quot;) SATA II, 1500G, 68g, Black</description>
            <title>A-DATA 128GB S599</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/5930238</uri>
        </Link>
        <Link type="Link">
            <description>S599 128GB Notebook Package SSD, 6.35 cm (2.5 &quot;) SATA II, 1500G, 68g, Black</description>
            <title>A-DATA 128GB S599</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/6830681</uri>
        </Link>
        <Link type="Link">
            <description>16GB C003, USB 2,0, 10g, Blue</description>
            <title>A-DATA 16GB C003</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/5079739</uri>
        </Link>
        <Link type="Link">
            <description>16GB C003, USB 2,0, 10g, Red</description>
            <title>A-DATA 16GB C003</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/5079721</uri>
        </Link>
        <Link type="Link">
            <description>16GB C008, 10g, White/Blue</description>
            <title>A-DATA 16GB C008</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/6946439</uri>
        </Link>
        <Link type="Link">
            <description>16GB C008, 10g, Black/Red</description>
            <title>A-DATA 16GB C008</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/6946438</uri>
        </Link>
        <Link type="Link">
            <description>16GB C906m USB 2.0, 9g, White</description>
            <title>A-DATA 16GB C906</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/5079756</uri>
        </Link>
        <Link type="Link">
            <description>16GB C906, USB 2.0, 9g, Black</description>
            <title>A-DATA 16GB C906</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/5079747</uri>
        </Link>
        <Link type="Link">
            <description>S101 - 16GB, USB 2.0, 4g, Black</description>
            <title>A-DATA 16GB S101</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/7415678</uri>
        </Link>
        <Link type="Link">
            <description>16GB S102, USB 3.0, 15g, Read/Write - 68/18mb/sec, Titanium grey</description>
            <title>A-DATA 16GB S102</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/7041208</uri>
        </Link>
        <Link type="Link">
            <description>16GB SDHC Class 10</description>
            <title>A-DATA 16GB SDHC Class 10</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/3596471</uri>
        </Link>
        <Link type="Link">
            <description>1TB CH94, 6.35 cm (2.5 &quot;) , USB 2.0, 210g, Black</description>
            <title>A-DATA CH94 Portable 1TB</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/M7972533</uri>
        </Link>
        <Link type="Link">
            <description>Retail Set: Benq T850 Red and Dicota CamPocket Zoom </description>
            <title>Benq T850 Red + Dicota CamPocket Zoom</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/M1610689</uri>
        </Link>
        <Link type="Link">
            <description>Product Bundle: Canon EOS 5D, Canon EF 50mm f/1.8 II and Photoshop CS5.5 </description>
            <title>Canon EOS 5D Mark II, body + Canon EF 50mm f/1.8 II + Adobe Photoshop CS5 Extended, Win, Retail, DE</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/M1718663</uri>
        </Link>
        <Link type="Link">
            <description>FRITZ!Box Fon WLAN 7170 Annex A</description>
            <title>Test127</title>
            <uri>PrimeTech-PrimeTechSpecials-Site/b2c-web-shop/categories/Cameras-Camcorders/products/859910</uri>
        </Link>
    </elements>
    <pageable>WrIKDACwCiUAAAFBTK2PZO9e</pageable>
</ResourceCollection>

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.

Support Europe
+49 (3641)501600
support@intershop.de
Corporate Headquarters
Intershop Communications AG
Steinweg 10
07743 Jena
Germany
Support America
(415) 844-3730
support@intershop.com
Customer Support
Home Page
How To Contact Us
ISO 9001 Certified
Support Plans
Additional Services
Product Support Matrix
Support Newsletter
Contract Datasheet
Feedback Form
Support News Archive
Knowledge Base
Home Page
Search
Personal Library
Product Resources
Home Page
Search
Custom Fixes for your Account
Difference Report
Product Support Matrix
Service Connector Matrix
Tickets
Home Page
Search
Ticket Statistics
New Ticket