Related Documents
Document Properties
Kbid2D7953
Last Modified23-Jun-2020
Added to KB01-Aug-2016
Public AccessEveryone
StatusOnline
Doc TypeReferences
Product
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

REST API - Create a quote request


Note

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

URI

/customers/<customerID>/users/<userID>/quoterequests

Http Method

POST

Short Description

Creates a quote request

Query Parameters

Optional parameters (can only be used exclusively):

quoteID - the ID of the quote to create the new quote request from
basketID - the ID of the basket to create the new quote request from

Example Requests

Create new empty quote request:
/customers/AgroNet/users/fbirdo@test.intershop.de/quoterequests

Create a new quote request based on the quote with the given ID:
/customers/AgroNet/users/fbirdo@test.intershop.de/quoterequests?quoteID=mwnAqMgoQWUAAAE8irJXwIE5

Create a new quote request based on the basket with the given ID:
/customers/AgroNet/users/fbirdo@test.intershop.de/quoterequests?basketID=n8YKDgAhNVQAAAFTQKgS.DdF

HTTP Status Codes

201 Created - If the quote request was successfully created
400 Bad Request - If the quote request can not be created

Possible values for header value "error-key":

    • basket.not_found.error
    • baskets.no_items.error
    • quote.not_found.error
    • quote.no_items.error

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

Creates an empty quote request, a new quote request from an existing quote or a new quote request from the basket

Cartridge

app_sf_rest_b2b
Application

SMB Web Shop

Product Version

7.8

Product To Version

 
Status

final

JSON

Request data format

application/json

Request related java object

com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource
com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.NewQuoteRequestRO

Request data example

Note

Deprecation

Since version 7.8 the quoteID and basketID should be passed as query parameters (see above).
It is still possible to put these parameters in the request body but this will be removed in future releases.

Create new quote request from existing quote:

{
   "quoteID": "mwnAqMgoQWUAAAE8irJXwIE5"
}

Create new quote request from basket:

{
   "basketID": "n8YKDgAhNVQAAAFTQKgS.DdF"
}

Or empty body for creating a new empty quote request.

 

Response data format

application/json

Response related java object

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

Response data example

{
  "type": "Link",
  "uri": "inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/users/fbirdo@test.intershop.de/quoterequests/QQ4KDgAV3Q8AAAFTxLWqGA0A",
  "title": "QQ4KDgAV3Q8AAAFTxLWqGA0A"
}

XML

Request data format

text/xml

Request related java object

com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource
com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.NewQuoteRequestRO

Request data example

Note

Deprecation

Since version 7.8 the quoteID and basketID should be passed as query parameters (see above).
It is still possible to put these parameters in the request body but this will be removed in future releases.

Create new quote request from existing quote:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<NewQuoteRequest type="NewQuoteRequest">
	<quoteID>ab57545c-4f24-48cf-9838-cb30e1ae49ce</quoteID>
</NewQuoteRequest>

Create new quote request from basket:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<NewQuoteRequest type="NewQuoteRequest">
	<basketID>30a8c5bb-da51-4688-a2bf-266049abe821</basketID>
</NewQuoteRequest>

Create new empty quote request:

<NewQuoteRequest/>

Response data format

text/xml

Response related java object

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

Response data example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Link type="Link">
    <title>mdMKDgAVFzkAAAFTkFKqGAz7</title>
    <uri>inSPIRED-inTRONICS_Business-Site/-/customers/AgroNet/users/fbirdo@test.intershop.de/quoterequests/mdMKDgAVFzkAAAFTkFKqGAz7</uri>
</Link>

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