Related Documents
Document Properties
KbidA25410
Last Modified23-Jun-2020
Added to KB10-Dec-2013
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.6
  • ICM 7.7
  • ICM 7.8

REST API - Get a list of active baskets (until 7.8)

URI

/baskets

Http Method

GET

Short Description

Gets all open baskets for the current user.

Query Parameters

none

Example Requests

/baskets

HTTP Status Codes

200 OK

400 Bad Request
       Possible value for header 'error-key':

    • basket.basket_user_required.error

Description

Gets a list of all open baskets for the user given by the authentication token.

Cartridge

app_sf_rest

Application

B2C Web Shop, SMB Web Shop

Product Version

7.4

Product To Version

7.8
Status

final

JSON

Request Data Format

application/json

Request related java object

n/a

Request Example

n/a

Response Data Format

application/json

Response related java object

com.intershop.sellside.rest.common.capi.resource.basket.BasketResource 
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>

Response Example

 {
    "elements":
    [
        {
            "type":"Link",
            "title":"pxQKAB1.UY8AAAFCtr8EEMeh",
            "uri":"PrimeTech-PrimeTechSpecials-Site/-/baskets/pxQKAB1.UY8AAAFCtr8EEMeh"
        },
        {
            "type":"Link",
            "title":"77gKAB1.iqsAAAFCUsAEEMeh",
            "uri":"PrimeTech-PrimeTechSpecials-Site/-/baskets/77gKAB1.iqsAAAFCUsAEEMeh"
        },
        {
            "type":"Link",
            "title":"YIEKAB1.heYAAAFC1MAEEMeh",
            "uri":"PrimeTech-PrimeTechSpecials-Site/-/baskets/YIEKAB1.heYAAAFC1MAEEMeh"
        }
    ],
    "type":"ResourceCollection",
    "name":"baskets"
}

XML

XML Request Data Format

text/xml

XML Request Java Objects

n/a

XML Request Example

n/a

XML Response Data Format

text/xml

XML Response Java Objects

com.intershop.sellside.rest.common.capi.resource.basket.BasketResource 
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO<LinkRO>

XML Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="baskets" type="ResourceCollection">
    <elements>
            <Link type="Link">
                    <title>pxQKAB1.UY8AAAFCtr8EEMeh</title>
                    <uri>PrimeTech-PrimeTechSpecials-Site/-/baskets/pxQKAB1.UY8AAAFCtr8EEMeh</uri>
            </Link>
            <Link type="Link">
                    <title>77gKAB1.iqsAAAFCUsAEEMeh</title>
                    <uri>PrimeTech-PrimeTechSpecials-Site/-/baskets/77gKAB1.iqsAAAFCUsAEEMeh</uri>
            </Link>
            <Link type="Link">
                    <title>YIEKAB1.heYAAAFC1MAEEMeh</title>
                    <uri>PrimeTech-PrimeTechSpecials-Site/-/baskets/YIEKAB1.heYAAAFC1MAEEMeh</uri>
            </Link>
    </elements>
</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.

Customer Support
Knowledge Base
Product Resources
Tickets