Related Documents
Document Properties
Kbid2R7776
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 the quote details


Note

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

URI

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

Http Method

GET

Short Description

Shows the details of a quote

Query Parameters

None

Example Requests

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

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> or the quote for <quoteID> is not found

Description

Shows the details of a quote

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.UserQuotesItemResource
com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.QuoteRO
com.intershop.component.rest.capi.resourceobject.LinkRO

Response data example

{
  "type": "Quote",
  "items": [
    {
      "type": "QuoteLineItem",
      "originQuantity": {
        "type": "Quantity",
        "value": 7,
        "unit": ""
      },
      "originSinglePrice": {
        "type": "Money",
        "value": 237.5,
        "currencyMnemonic": "USD"
      },
      "originTotalPrice": {
        "type": "Money",
        "value": 1662.5,
        "currencyMnemonic": "USD"
      },
      "quantity": {
        "type": "Quantity",
        "value": 7,
        "unit": ""
      },
      "singlePrice": {
        "type": "Money",
        "value": 220,
        "currencyMnemonic": "USD"
      },
      "totalPrice": {
        "type": "Money",
        "value": 1540,
        "currencyMnemonic": "USD"
      },
      "productSKU": "9438012"
    }
  ],
  "displayName": "new name...",
  "id": "59sKDgAho9UAAAFUFy0h_DO6",
  "number": "0000101",
  "description": "new description...",
  "creationDate": 1461156719940,
  "validFromDate": 1461156660000,
  "validToDate": 1461761460000,
  "sellerComment": "Only 1 week valid!",
  "originTotal": {
    "type": "Money",
    "value": 1662.5,
    "currencyMnemonic": "USD"
  },
  "total": {
    "type": "Money",
    "value": 1540,
    "currencyMnemonic": "USD"
  }
}

If a quote was rejected by the buyer an additional attribute rejected is contained in the result

{
  "type": "Quote",
  "displayName": "new name...",
  "id": "59sKDgAho9UAAAFUFy0h_DO6",
  "number": "0000101",
  ...
  "rejected" : true
}

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.UserQuotesItemResource
com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.QuoteRO
com.intershop.component.rest.capi.resourceobject.LinkRO

Response data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Quote type="Quote">
    <creationDate>2016-04-20T14:51:59.940+02:00</creationDate>
    <description>new description...</description>
    <displayName>new name...</displayName>
    <id>59sKDgAho9UAAAFUFy0h_DO6</id>
    <items type="QuoteLineItem">
        <originQuantity type="Quantity">
            <unit></unit>
            <value>7</value>
        </originQuantity>
        <originSinglePrice type="Money">
            <currencyMnemonic>USD</currencyMnemonic>
            <value>237.5</value>
        </originSinglePrice>
        <originTotalPrice type="Money">
            <currencyMnemonic>USD</currencyMnemonic>
            <value>1662.50</value>
        </originTotalPrice>
        <productSKU>9438012</productSKU>
        <quantity type="Quantity">
            <unit></unit>
            <value>7</value>
        </quantity>
        <singlePrice type="Money">
            <currencyMnemonic>USD</currencyMnemonic>
            <value>220.00</value>
        </singlePrice>
        <totalPrice type="Money">
            <currencyMnemonic>USD</currencyMnemonic>
            <value>1540.00000</value>
        </totalPrice>
    </items>
    <number>0000101</number>
    <originTotal type="Money">
        <currencyMnemonic>USD</currencyMnemonic>
        <value>1662.50</value>
    </originTotal>
    <sellerComment>Only valid 1 week!</sellerComment>
    <total type="Money">
        <currencyMnemonic>USD</currencyMnemonic>
        <value>1540.00</value>
    </total>
    <validFromDate>2016-04-20T14:51:00+02:00</validFromDate>
    <validToDate>2016-04-27T14:51:00+02:00</validToDate>
</Quote>

If a quote was rejected by the buyer an additional attribute rejected is contained in the result:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Quote type="Quote">
    <creationDate>2016-04-20T14:51:59.940+02:00</creationDate>
    <description>new description...</description>
    <displayName>new name...</displayName>
    <id>59sKDgAho9UAAAFUFy0h_DO6</id>
    ...
    <rejected>true</rejected>
</Quote>

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