This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
This section covers operations for managing quotes. This includes retrieving a list of available quotes as well as submitting, viewing, rejecting or deleting individual quotes.
/customers/{CustomerKey}/users/{CustomerItemUserKey}/quotes
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesListResource.getQuotes(java.lang.String,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | state | string | Possible states: - RESPONDED - REJECTED | ||
in query | attrs | string | The following attributes are available: - number - The quote number- name - Name of the quote- lineItems - Number of line items contained in the quote (a line item might have multiple quantities)- creationDate - Date on which the quote was created- validFromDate - Begin of the quote's period of validity- validToDate - End of the quote's period of validity- rejected - Flag indicating whether the quote is rejected (by end user)Use a comma-separated list for multiple values e.g. " attrs=number,name ". |
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesListResource.submitQuoteRequest(com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.SubmitQuoteRequestRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
202 - Accepted
401 - Unauthorized
403 - Forbidden
404 - Not Found
/customers/{CustomerKey}/users/{CustomerItemUserKey}/quotes/{UserQuotesKey}
This operation returns details of a quote.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource.getQuoteDetails()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuotesKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
This operation marks a quote as rejected, i.e. it can no longer be added to a basket. The account manager can see that the quote has been rejected. It is possible to create a new independent quote request based on the rejected quote.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource.updateQuote(com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.UpdateQuoteRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuotesKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
This operation deletes a quote based on the provided parameters.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource.deleteQuote()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuotesKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content
401 - Unauthorized
403 - Forbidden
404 - Not Found
This section covers operations for managing quote requests. This includes viewing, creating and deleting quote requests. Furthermore, it is possible to manage individual items within a quote request.
/customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests
This operations returns a list of user-specific quote requests. The list contains links to quote request details but can optionally be extended with additional attributes using the query parameter "attrs".
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource.getQuoteRequests(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | attrs | string | The following attributes are available: - number - The quote request number- name - Name of the quote request- lineItems - Number of line items contained in the quote request (a line item might have multiple quantities)- creationDate - Date on which the quote request was created- submittedDate - Date on which the quote request was submitted; missing if the quote request has not yet been submitted- editable - Flag indicating whether the quote request is editable- submitted - Flag indicating whether the quote request is submittedUse a comma-separated list for multiple values e.g. " attrs=number,name ". |
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
This operation creates a new quote request. It is possible to create either an empty quote request or a quote request based on existing objects. Existing objects could be another quote request, a quote or a basket. In this case all available line items of the existing quote, quote request or basket are copied into the new quote request. Offline products will be skipped.
The following parameters are available (please provide at most one parameter):
quoteID
- Quote request based on existing quote: Provide quote IDquoteRequestID
- Quote request based on existing quote request: Provide quote request IDbasketID
- Quote request based on existing basket: Provide basket IDNote: The parameter "newQuoteRequestRO" is deprecated and should not be used anymore. Use query parameters "quoteID", "basketID" or "quoteRequestID" instead.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource.createQuoteRequest(com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.NewQuoteRequestRO,java.lang.String,java.lang.String,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in query | quoteID | string | The ID of the quote. Used to create a quote request based on an existing quote. | ||
in query | basketID | string | The ID of the basket. Used to create a quote request based on an existing basket. | ||
in query | quoteRequestID | string | The ID of the quote request. Used to create a quote request based on an existing quote request. |
201 - Created
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
/customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests/{UserQuoteRequestsKey}
This operation returns details of a quote request by the given ID. If the quote request was already submitted an responded then the quote request is
transformed into a quote. In this case the response contains the status code 303 (See other) and the link to the quotes resource.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsItemResource.getQuoteRequestDetails()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuoteRequestsKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
303 - See Other
Link to the created quote because the request quote request has become a quote.
401 - Unauthorized
403 - Forbidden - A user with insufficient permissions tries to access the quote request or the quote request is not editable.
404 - Not Found - A quote request with the given UserQuoteRequestsKey is not found.
This operation updates the name and/or description of a quote request, provided it is editable (not submitted). If no value is provided, the field is not updated (partial update). Quote line items are not affected.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsItemResource.updateQuoteRequest(com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.QuoteRequestRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuoteRequestsKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
400 - Bad Request , if no data to update is provided
401 - Unauthorized
403 - Forbidden - A user with insufficient permissions tries to access the quote request or the quote request is not editable.
404 - Not Found - A quote request with the given UserQuoteRequestsKey is not found.
This operation deletes a quote request based on the provided parameters.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsItemResource.deleteQuoteRequest()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuoteRequestsKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content
401 - Unauthorized
403 - Forbidden - A user with insufficient permissions to access the quote request or the quote request is not editable.
404 - Not Found - A quote request with the given UserQuoteRequestsKey is not found.
/customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests/{UserQuoteRequestsKey}/items
This operation returns a list of line items for the quote request with the specified UserQuoteRequestsKey.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemListResource.getQuoteRequestLineItems()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuoteRequestsKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
403 - Forbidden - A user with insufficient permissions tries to access the quote request or the quote request is not editable.
404 - Not Found - A quote request with the given UserQuoteRequestsKey is not found.
This operation sets the list of quote line items if the quote request is editable. If there are already items in the list, they will be replaced by the new list. Every product is validated before it can be added.
A validator checks whether a product with the specified SKU exists and whether it is online and available. The result object contains a list of SKUs which could not be added to the quote request (failedSKUs).
Additionally a field status indicates whether there were failures (values "SUCCESS", "ERROR").
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemListResource.setQuoteLineItems(com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.QuoteRequestLineItemROResourceCollection)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuoteRequestsKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden - A user with insufficient permissions tries to access the quote request or the quote request is not editable.
404 - Not Found - A quote request with the given UserQuoteRequestsKey is not found.
This operation creates a line item for the quote request. A validator checks whether a product with the specified SKU exists and whether it is online and available.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemListResource.createQuoteLineItem(com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.QuoteRequestLineItemRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuoteRequestsKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
201 - Created
400 - Bad Request , if no data for the line item is provided or validation of product failed
401 - Unauthorized
403 - Forbidden - A user with insufficient permissions tries to access the quote request or the quote request is not editable.
404 - Not Found - A quote request with the given UserQuoteRequestsKey is not found.
/customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests/{UserQuoteRequestsKey}/items/{UserQuoteRequestsLineKey}
This operation returns a line item of a quote request, based on the provided parameters.
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemResource.getQuoteRequestLineItemDetails()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuoteRequestsKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuoteRequestsLineKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
401 - Unauthorized
403 - Forbidden
404 - Not Found
This operation updates the quantity of a line item, provided the quote request is editable (not submitted).
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemResource.updateQuoteRequestLineItem(com.intershop.application.storefront.rest.b2b.capi.quote.resourceobject.QuoteRequestLineItemRO)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuoteRequestsKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuoteRequestsLineKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
200 - OK
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
This operation deletes a line item of a quote request, provided the quote request is editable (not submitted).
public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemResource.deleteQuoteRequestLineItem()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | CustomerKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | CustomerItemUserKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuoteRequestsKey | string | ExampleKey | Required | The key or UUID to resolve a single item | |
in path | UserQuoteRequestsLineKey | string | ExampleKey | Required | The key or UUID to resolve a single item |
204 - No Content
401 - Unauthorized
403 - Forbidden
404 - Not Found
Link
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
mwnAqMgoQWUAAAE8irJXwIE5
n8YKDgAhNVQAAAFTQKgS.DdF
string
literals. The product SKUs of the failed productsSUCCESS,ERROR
QuoteLineItemRO
objects. The line items of the quote as collection of QuoteLineItemROsQuoteLineItemRO
: This resource holds information on the quote line item.QuantityRO
object. Quantity combines a quantity value and the ISO unit code the value is defined in.Quantity
10.99
PIEC
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
QuantityRO
object. Quantity combines a quantity value and the ISO unit code the value is defined in.Quantity
10.99
PIEC
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
9438012
new name...
59sKDgAho9UAAAFUFy0h_DO6
0000101
new description...
date-time
date-time
date-time
Only 1 week valid!
true
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
QuantityRO
object. Quantity combines a quantity value and the ISO unit code the value is defined in.Quantity
10.99
PIEC
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
9438012
XW.sGLABFUgAAAFu67ET4H2R
int32
int32
int32
QuoteRequestLineItemRO
objects. The list of elementsQuoteRequestLineItemRO
: This resource holds information on the quote request line item.QuantityRO
object. Quantity combines a quantity value and the ISO unit code the value is defined in.Quantity
10.99
PIEC
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
9438012
XW.sGLABFUgAAAFu67ET4H2R
string
literals. The keys to sort for0000101
59sKDgAho9UAAAFUFy0h_DO6
0000101
description
true
true
date-time
date-time
MoneyRO
object. Money combines a currency and a money amount.Money
10.99
USD
LinkRO
objects. A list of all items for the given quote request as LinkROsLinkRO
: A Link pointing to a resourceLink
ResourceAttribute
objects. the list of attributesResourceAttribute
: An attributeResourceAttribute
about
alternate
appendix
archives
author
bookmark
canonical
chapter
collection
contents
copyright
create-form
current
describedby
describes
disclosure
duplicate
edit
edit-form
edit-media
enclosure
first
glossary
help
hosts
hub
icon
index
item
last
latest-version
license
lrdd
monitor
monitor-group
next
next-archive
nofollow
noreferrer
payment
predecessor-version
prefetch
prev
preview
previous
prev-archive
privacy-policy
profile
related
replies
search
section
self
service
start
stylesheet
subsection
successor-version
tag
terms-of-service
type
up
version-history
via
working-copy
working-copy-of
ResourceAttribute
object. An attributeResourceAttribute
int32
int32
int32
AbstractResourceObject
objects. The list of elementsAbstractResourceObject
: the list of elementsstring
literals. The keys to sort forOmwKDgAhF5IAAAFTgy8bsDHK
true