Related Documents
Document Properties
Kbid27765P
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 a list of quotes


Note

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

URI

/customers/<customerID>/users/<userID>/quotes

Http Method

GET

Short Description

Retrieves a list of quotes, optionally filtered by the quote state

Query Parameters

state - optional field that filters the list depending on the quote state.

The following values are supported:

  • responded
  • rejected

attrs - optional field to specify additional fields for the list

The following values are supported:

  • number
  • name
  • lineItems (number of line items)
  • creationDate
  • validFromDate
  • validToDate

Example Requests

/customers/AgroNet/users/fbirdo@test.intershop.de/quotes

/customers/AgroNet/users/fbirdo@test.intershop.de/quotes?state=rejected&attrs=number

HTTP Status Codes

200 OK
401 Unauthorized - If no authorization is provided or authorization is wrong
403 Forbidden - If the user is not allowed
404 Not found - If customer for <customerID> or user for <userID> is not found

Description

Get a list of the user quotes which can filtered with an optional parameter state.

Cartridge

app_sf_rest_b2b
Application

SMB Web Shop

Product Version

7.7

Product To Version

 
Status

final

JSON

Request data format

application/json

Request related java object

None

Request data example

None

Response data format

application/json

Response related java object

com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesListResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
com.intershop.component.rest.capi.resourceobject.LinkRO

Response data example

{
    "elements": [{
        "type": "Link",
        "uri": "inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/users/fbirdo@test.intershop.de/quotes/QzcKDgAs.7UAAAFSI2ti_O4X",
        "title": "QzcKDgAs.7UAAAFSI2ti_O4X"
    },
    {
        "type": "Link",
        "uri": "inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/users/fbirdo@test.intershop.de/quotes/aOcKDgAsXPMAAAFS9u8q1OSD",
        "title": "aOcKDgAsXPMAAAFS9u8q1OSD"
    },
    {
        "type": "Link",
        "uri": "inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/users/fbirdo@test.intershop.de/quotes/v.UKDgAstE4AAAFSRvMq1OSD",
        "title": "v.UKDgAstE4AAAFSRvMq1OSD"
    }],
    "type": "ResourceCollection",
    "name": "quotes"
}

XML

Request data format

text/xml

Request related java object

None

Request data example

None

Response data format

text/xml

Response related java object

com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesListResource
com.intershop.component.rest.capi.resourceobject.ResourceCollectionRO
com.intershop.component.rest.capi.resourceobject.LinkRO

Response data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ResourceCollection name="quotes" type="ResourceCollection">
    <elements>
        <Link type="Link">
            <attributes>
                <ResourceAttribute name="number" type="String">
                    <value>0000001</value>
                </ResourceAttribute>
            </attributes>
            <title>CeAKDgAVUjwAAAFTc1iqGAz5</title>
            <uri>inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/users/fbirdo@test.intershop.de/quotes/CeAKDgAVUjwAAAFTc1iqGAz5</uri>
        </Link>
        <Link type="Link">
            <attributes>
                <ResourceAttribute name="number" type="String">
                    <value>0000002</value>
                </ResourceAttribute>
            </attributes>
            <title>g8cKDgAVEs8AAAFTxWaqGAz5</title>
            <uri>inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/users/fbirdo@test.intershop.de/quotes/g8cKDgAVEs8AAAFTxWaqGAz5</uri>
        </Link>
        <Link type="Link">
            <attributes>
                <ResourceAttribute name="number" type="String">
                    <value>0000003</value>
                </ResourceAttribute>
            </attributes>
            <title>HIsKDgAV1KAAAAFTSbqqGAz5</title>
            <uri>inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/users/fbirdo@test.intershop.de/quotes/HIsKDgAV1KAAAAFTSbqqGAz5</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
Support Tickets