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

REST API - Reject a quote


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

PUT

Short Description

Rejects a quote

Query Parameters

None

Example Requests

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

HTTP Status Codes

200 OK
400 Bad Request - if the Quote is already rejected
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

The quote is marked as rejected and can no longer be added to a basket. The Account Manager can see that the quote has been rejected. It's possible to create new quote requests from a rejected 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

com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource
com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.UpdateQuoteRO

Request data example

{
    "rejected": true
}

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!",
  "rejected": true,  
  "originTotal": {
    "type": "Money",
    "value": 1662.5,
    "currencyMnemonic": "USD"
  },
  "total": {
    "type": "Money",
    "value": 1540,
    "currencyMnemonic": "USD"
  }
}

XML

Request data format

text/xml

Request related java object

com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource
com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.UpdateQuoteRO


Request data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Quote type="Quote">
    <rejected>true</rejected>
</Quote>

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>
    <rejected>true</rejected>
    <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>

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