Related Documents
Document Properties
Kbid29602L
Last Modified13-Apr-2021
Added to KB03-Sep-2020
Public AccessEveryone
StatusOnline
Doc TypeReferences
ProductICM 7.10

Reference - Quoting API 1.0.0


Product Version

7.10

Product To Version


Status

final

Download Specification 

This API specification is available for download as an Open API 3.0 YAML file: 

API Specification

Introduction

OpenAPI Version: 3.0.1
Quoting Version: 1.0.0

The Intershop Quoting REST API contains resources for managing quotes and quote requests. With the operations provided in this REST API it is possible to create, update and remove quotes and quote requests.

Quote API

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
GET: Retrieves a list of quotes

Description

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesListResource.getQuotes(java.lang.String,java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in querystatestringPossible states:
- RESPONDED
- REJECTED
in queryattrsstringThe 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".

Response

200 - OK

ResourceCollectionRO application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

POST: Submits a quote request

Description

Java Method

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)

Request Body

SubmitQuoteRequestRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

202 - Accepted

401 - Unauthorized

403 - Forbidden

404 - Not Found

/customers/{CustomerKey}/users/{CustomerItemUserKey}/quotes/{UserQuotesKey}
GET: Returns details of a quote

Description

This operation returns details of a quote.

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource.getQuoteDetails()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuotesKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

QuoteRO application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

PUT: Rejects a quote

Description

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.

Java Method

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)

Request Body

UpdateQuoteRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuotesKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

QuoteRO application/json

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

DELETE: Deletes a quote

Description

This operation deletes a quote based on the provided parameters.

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource.deleteQuote()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuotesKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

401 - Unauthorized

403 - Forbidden

404 - Not Found

Quote Request API

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
GET: Returns a list of quote requests

Description

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".

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource.getQuoteRequests(java.lang.String)

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryattrsstringThe 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 submitted

Use a comma-separated list for multiple values e.g. "attrs=number,name".

Response

200 - OK

ResourceCollectionRO application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

POST: Creates a quote request

Description

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):

  • no parameter - Empty quote request
  • quoteID - Quote request based on existing quote: Provide quote ID
  • quoteRequestID - Quote request based on existing quote request: Provide quote request ID
  • basketID - Quote request based on existing basket: Provide basket ID

Note: The parameter "newQuoteRequestRO" is deprecated and should not be used anymore. Use query parameters "quoteID", "basketID" or "quoteRequestID" instead.

Java Method

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)

Request Body

NewQuoteRequestRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in queryquoteIDstringThe ID of the quote. Used to create a quote request based on an existing quote.
in querybasketIDstringThe ID of the basket. Used to create a quote request based on an existing basket.
in queryquoteRequestIDstringThe ID of the quote request. Used to create a quote request based on an existing quote request.

Response

201 - Created

LinkRO application/json

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

/customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests/{UserQuoteRequestsKey}
GET: Returns a quote request by given ID

Description

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.

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsItemResource.getQuoteRequestDetails()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuoteRequestsKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

QuoteRequestRO application/json

303 - See Other


Link to the created quote because the request quote request has become a quote.
LinkRO application/json

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.
PUT: Updates data of a quote request

Description

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.

Java Method

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)

Request Body

QuoteRequestRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuoteRequestsKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

QuoteRequestRO application/json

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.
DELETE: Delete a quote request

Description

This operation deletes a quote request based on the provided parameters.

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsItemResource.deleteQuoteRequest()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuoteRequestsKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

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
GET: Returns line items of a quote request

Description

This operation returns a list of line items for the quote request with the specified UserQuoteRequestsKey.

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemListResource.getQuoteRequestLineItems()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuoteRequestsKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

ResourceCollectionRO application/json

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.
PUT: Sets the list of quote line items

Description

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").

Java Method

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)

Request Body

QuoteRequestLineItemROResourceCollection application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuoteRequestsKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

QuoteLineItemResultRO application/json

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.
POST: Creates line item for the quote request

Description

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.

Java Method

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)

Request Body

QuoteRequestLineItemRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuoteRequestsKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

201 - Created

LinkRO application/json

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}
GET: Returns a line item of a quote request

Description

This operation returns a line item of a quote request, based on the provided parameters.

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemResource.getQuoteRequestLineItemDetails()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuoteRequestsKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuoteRequestsLineKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

QuoteRequestLineItemRO application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

PUT: Updates the line item of a quote request (quantity)

Description

This operation updates the quantity of a line item, provided the quote request is editable (not submitted).

Java Method

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)

Request Body

QuoteRequestLineItemRO application/json

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuoteRequestsKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuoteRequestsLineKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

200 - OK

QuoteRequestLineItemRO application/json

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

DELETE: Deletes a line item of a quote request

Description

This operation deletes a line item of a quote request, provided the quote request is editable (not submitted).

Java Method

public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemResource.deleteQuoteRequestLineItem()

Request Body

--

Request Parameters

LocationNameFormatDescription
in pathCustomerKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathCustomerItemUserKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuoteRequestsKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey
in pathUserQuoteRequestsLineKeystringRequired | The key or UUID to resolve a single item | Example: ExampleKey

Response

204 - No Content

401 - Unauthorized

403 - Forbidden

404 - Not Found

Request and Response Object Schemata

LinkRO application/json{
  • "name":
    string
    the name of the returned element
  • "type":
    string
    Readonly | This is a constant: Link | Example: Link
  • "attributes":
    array
    An array of ResourceAttribute objects. the list of attributes
    [
    ResourceAttribute: An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
    ]
  • "uri":
    string
    The uri
  • "relation":
    string
    The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
  • "title":
    string
    The title of the link
  • "description":
    string
    The description of the link
  • "itemId":
    string
    the Id of the linked item
  • "attribute":
    object
    A ResourceAttribute object. An attribute
    {
    • "name":
      string
      The attribute's name
    • "type":
      string
      This is a constant: ResourceAttribute | Example: ResourceAttribute
    • "value":
      object
      The attribute's value.
    }
}
NewQuoteRequestRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "quoteID":
    string
    The ID of the quote | Example: mwnAqMgoQWUAAAE8irJXwIE5
  • "basketID":
    string
    The ID of the basket | Example: n8YKDgAhNVQAAAFTQKgS.DdF
}
QuoteLineItemResultRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "failedProductSKUs":
    array
    An array of string literals. The product SKUs of the failed products
  • "status":
    string
    Indicates whether the result contains failed products | Example: SUCCESS,ERROR
}
QuoteRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "items":
    array
    An array of QuoteLineItemRO objects. The line items of the quote as collection of QuoteLineItemROs
    [
    QuoteLineItemRO: This resource holds information on the quote line item.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "originQuantity":
      object
      A QuantityRO object. Quantity combines a quantity value and the ISO unit code the value is defined in.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | This is a constant: Quantity | Example: Quantity
      • "value":
        number
        The quantity's value | Example: 10.99
      • "unit":
        string
        The quantity's ISO unit code. | Example: PIEC
      }
    • "originSinglePrice":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "originTotalPrice":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "quantity":
      object
      A QuantityRO object. Quantity combines a quantity value and the ISO unit code the value is defined in.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | This is a constant: Quantity | Example: Quantity
      • "value":
        number
        The quantity's value | Example: 10.99
      • "unit":
        string
        The quantity's ISO unit code. | Example: PIEC
      }
    • "singlePrice":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "totalPrice":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "productSKU":
      string
      The product SKU | Example: 9438012
    }
    ]
  • "displayName":
    string
    The display name of a quote | Example: new name...
  • "id":
    string
    The ID of a quote | Example: 59sKDgAho9UAAAFUFy0h_DO6
  • "number":
    string
    The number of a quote | Example: 0000101
  • "description":
    string
    The description of a quote | Example: new description...
  • "creationDate":
    string
    The creation date of a quote | Format: date-time
  • "validFromDate":
    string
    The valid from date of a quote | Format: date-time
  • "validToDate":
    string
    The valid to date of a quote | Format: date-time
  • "sellerComment":
    string
    Comment of the seller on a quote | Example: Only 1 week valid!
  • "rejected":
    boolean
    Indicates whether the quote is rejected | Example: true
  • "originTotal":
    object
    A MoneyRO object. Money combines a currency and a money amount.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | This is a constant: Money | Example: Money
    • "value":
      number
      The monetary value. | Example: 10.99
    • "currencyMnemonic":
      string
      Deprecated
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    }
  • "total":
    object
    A MoneyRO object. Money combines a currency and a money amount.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | This is a constant: Money | Example: Money
    • "value":
      number
      The monetary value. | Example: 10.99
    • "currencyMnemonic":
      string
      Deprecated
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    }
}
QuoteRequestLineItemRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "quantity":
    object
    A QuantityRO object. Quantity combines a quantity value and the ISO unit code the value is defined in.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | This is a constant: Quantity | Example: Quantity
    • "value":
      number
      The quantity's value | Example: 10.99
    • "unit":
      string
      The quantity's ISO unit code. | Example: PIEC
    }
  • "singlePrice":
    object
    A MoneyRO object. Money combines a currency and a money amount.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | This is a constant: Money | Example: Money
    • "value":
      number
      The monetary value. | Example: 10.99
    • "currencyMnemonic":
      string
      Deprecated
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    }
  • "totalPrice":
    object
    A MoneyRO object. Money combines a currency and a money amount.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | This is a constant: Money | Example: Money
    • "value":
      number
      The monetary value. | Example: 10.99
    • "currencyMnemonic":
      string
      Deprecated
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    }
  • "productSKU":
    string
    The product SKU | Example: 9438012
  • "id":
    string
    The ID of the quote request line item | Example: XW.sGLABFUgAAAFu67ET4H2R
}
QuoteRequestLineItemROResourceCollection application/json{
  • "pageable":
    string
    The pageable ID
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of QuoteRequestLineItemRO objects. The list of elements
    [
    QuoteRequestLineItemRO: This resource holds information on the quote request line item.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    • "quantity":
      object
      A QuantityRO object. Quantity combines a quantity value and the ISO unit code the value is defined in.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | This is a constant: Quantity | Example: Quantity
      • "value":
        number
        The quantity's value | Example: 10.99
      • "unit":
        string
        The quantity's ISO unit code. | Example: PIEC
      }
    • "singlePrice":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "totalPrice":
      object
      A MoneyRO object. Money combines a currency and a money amount.
      {
      • "name":
        string
        The name of an element.
      • "type":
        string
        Readonly | This is a constant: Money | Example: Money
      • "value":
        number
        The monetary value. | Example: 10.99
      • "currencyMnemonic":
        string
        Deprecated
      • "currency":
        string
        Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
      }
    • "productSKU":
      string
      The product SKU | Example: 9438012
    • "id":
      string
      The ID of the quote request line item | Example: XW.sGLABFUgAAAFu67ET4H2R
    }
    ]
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element.
}
QuoteRequestRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "displayName":
    string
    The display name of the quote request | Example: 0000101
  • "id":
    string
    The ID of the quote request | Example: 59sKDgAho9UAAAFUFy0h_DO6
  • "number":
    string
    The number of the quote request | Example: 0000101
  • "description":
    string
    The description of the quote request | Example: description
  • "editable":
    boolean
    Indicates whether the quote request is editable | Example: true
  • "submitted":
    boolean
    Indicates whether the quote request is submitted | Example: true
  • "creationDate":
    string
    The creation date of the quote request | Format: date-time
  • "submittedDate":
    string
    The date the quote request was submitted | Format: date-time
  • "total":
    object
    A MoneyRO object. Money combines a currency and a money amount.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | This is a constant: Money | Example: Money
    • "value":
      number
      The monetary value. | Example: 10.99
    • "currencyMnemonic":
      string
      Deprecated
    • "currency":
      string
      Three-letter currency code (ISO 4217) of the monetary value. | Example: USD
    }
  • "items":
    array
    An array of LinkRO objects. A list of all items for the given quote request as LinkROs
    [
    LinkRO: A Link pointing to a resource
    {
    • "name":
      string
      the name of the returned element
    • "type":
      string
      Readonly | This is a constant: Link | Example: Link
    • "attributes":
      array
      An array of ResourceAttribute objects. the list of attributes
      [
      ResourceAttribute: An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
      ]
    • "uri":
      string
      The uri
    • "relation":
      string
      The relation of the link | Documentation: Link Relations (www.iana.org) | Possible Values: aboutalternateappendixarchivesauthorbookmarkcanonicalchaptercollectioncontentscopyrightcreate-formcurrentdescribedbydescribesdisclosureduplicateeditedit-formedit-mediaenclosurefirstglossaryhelphostshubiconindexitemlastlatest-versionlicenselrddmonitormonitor-groupnextnext-archivenofollownoreferrerpaymentpredecessor-versionprefetchprevpreviewpreviousprev-archiveprivacy-policyprofilerelatedrepliessearchsectionselfservicestartstylesheetsubsectionsuccessor-versiontagterms-of-servicetypeupversion-historyviaworking-copyworking-copy-of
    • "title":
      string
      The title of the link
    • "description":
      string
      The description of the link
    • "itemId":
      string
      the Id of the linked item
    • "attribute":
      object
      A ResourceAttribute object. An attribute
      {
      • "name":
        string
        The attribute's name
      • "type":
        string
        This is a constant: ResourceAttribute | Example: ResourceAttribute
      • "value":
        object
        The attribute's value.
      }
    }
    ]
}
ResourceCollectionRO application/json{
  • "pageable":
    string
    The pageable ID
  • "total":
    integer
    The pageable amount total | Format: int32
  • "offset":
    integer
    The pageable offset | Format: int32
  • "amount":
    integer
    The pageable amount | Format: int32
  • "elements":
    array
    An array of AbstractResourceObject objects. The list of elements
    [
    AbstractResourceObject: the list of elements
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
    }
    ]
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "sortKeys":
    array
    An array of string literals. The keys to sort for
  • "name":
    string
    The name of an element.
}
SubmitQuoteRequestRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "quoteRequestID":
    string
    The quote request ID. | Example: OmwKDgAhF5IAAAFTgy8bsDHK
}
UpdateQuoteRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    Readonly | The type of the object. This is normally a constant that can be used to differentiate objects by their type.
  • "rejected":
    boolean
    Indicates whether the quote is rejected | Example: true
}

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