Document Properties
Kbid29602L
Last Modified02-Nov-2020
Added to KB03-Sep-2020
Public AccessEveryone
StatusOnline
Doc TypeReferences
ProductICM 7.10

Reference - ICM REST API - B2B Front End - Quoting 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

This is Intershop ICM REST API documentation.

This reference lists the REST API for storefront development. The REST API covers features of both, the B2C (SMB - Small and Medium-sized businesses) and the B2B storefront development.
This reference is intended for developers who want to make use of an easy-to-use API when developing frontend solutions.
You can find more information at Intershop Communications. Contact our Intershop experts at Support - Intershop Communications

Introduction

This API is documented in OpenAPI format.

Quote API

/customers/{CustomerKey}/users/{CustomerItemUserKey}/quotes
GET: Retrieves a list of quotes, optionally filtered by the quote state.

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 querystatestring
in queryattrsstring

Response

200 - OK

Object 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

200 - OK

Object application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

/customers/{CustomerKey}/users/{CustomerItemUserKey}/quotes/{UserQuotesKey}
GET: Shows the details of a quote.

Description

--

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

--

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

--

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

/customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests
GET: Retrieves a list of quote requests.

Description

ResourceCollectionRO contains object from type LinkRO

Java Method

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

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

Response

200 - OK

Object application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

POST: Creates a quote request.

Description

Parameter 'newQuoteRequestRO' is deprecated and should not be used anymore. Use query parameters "quoteID" and "basketID" 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)

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 queryquoteIDstringquoteID is needed to create a quote request based on an existing quote
in querybasketIDstringbasketID is needed to create a quote request based on an existing basket

Response

201 - Created

LinkRO application/json

400 - Bad Request

401 - Unauthorized

403 - Forbidden

404 - Not Found

/customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests/{UserQuoteRequestsKey}
GET: Get a quote request by a given id.

Description

In case that no quote request can be found try to find a quote and return it (reference to a quote).

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

404 - Not Found

PUT: Updates data of a quote request.

Description

--

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

401 - Unauthorized

403 - Forbidden

404 - Not Found

DELETE: Delete a quote request.

Description

--

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

404 - Not Found

/customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests/{UserQuoteRequestsKey}/items
GET: Gets the list of line items of a quote request.

Description

ResourceCollectionRO contains object from type LinkRO

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

Object application/json

401 - Unauthorized

403 - Forbidden

404 - Not Found

PUT: Sets the list of quote line items.

Description

--

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

404 - Not Found

POST: Creates a line item for the quote request with the given 'quoteRequestID'.

Description

--

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

401 - Unauthorized

403 - Forbidden

404 - Not Found

/customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests/{UserQuoteRequestsKey}/items/{UserQuoteRequestsLineKey}
GET: Gets a line item of a quote request.

Description

--

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

--

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

--

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
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: NewQuoteRequest
  • "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
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: QuoteLineItemResult
  • "failedProductSKUs":
    array
    An array of string literals. The failed product SKUs.
  • "status":
    string
    Shows if the results has failures. | Example: SUCCESS
}
QuoteRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: Quote
  • "items":
    array
    An array of QuoteLineItemRO objects. The line items of the quote as collection of QuoteLineItemROs
    [
    QuoteLineItemRO: Information about the quote line item.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: QuoteLineItem
    • "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
    The seller comment of a quote. | Example: Only 1 week valid!
  • "rejected":
    boolean
    Is the quote 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
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: QuoteRequestLineItem
  • "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: Holds information about the quote request line item.
    {
    • "name":
      string
      The name of an element.
    • "type":
      string
      The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: QuoteRequestLineItem
    • "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. | Example: QuoteRequestLineItemCollection
  • "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
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: QuoteRequest
  • "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 quote request. | Example: 0000101
  • "description":
    string
    The description of the quote request. | Example: description
  • "editable":
    boolean
    Is the quote request changeable. | Example: true
  • "submitted":
    boolean
    Is the quote request submitted. | Example: true
  • "creationDate":
    string
    The creation date of the quote request. | Format: date-time
  • "submittedDate":
    string
    The submitted date of the quote request. | 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.
      }
    }
    ]
}
SubmitQuoteRequestRO application/json{
  • "name":
    string
    The name of an element.
  • "type":
    string
    The type of the object. This is normally a constant that can be used to differentiate objects by their type. | Example: QuoteRequest
  • "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
    Is the quote rejected. | Example: true
}
Object application/json{
  • "links":
    array
    An array of object literals.
    [
    {
    • "uri":
      string
      Format: uri
    • "title":
      string
    • "uriBuilder":
      object
    • "rel":
      string
    • "rels":
      array
      An array of string literals.
    • "params":
      object
    • "type":
      string
    }
    ]
  • "statusInfo":
    object
    {
    • "reasonPhrase":
      string
    • "statusCode":
      integer
      Format: int32
    • "family":
      string
      Possible Values: INFORMATIONALSUCCESSFULREDIRECTIONCLIENT_ERRORSERVER_ERROROTHER
    }
  • "allowedMethods":
    array
    An array of string literals.
  • "stringHeaders":
    object
    {
    • "empty":
      boolean
    }
  • "mediaType":
    object
    {
    • "type":
      string
    • "subtype":
      string
    • "parameters":
      object
    • "wildcardType":
      boolean
    • "wildcardSubtype":
      boolean
    }
  • "entityTag":
    object
    {
    • "value":
      string
    • "weak":
      boolean
    }
  • "metadata":
    object
    {
    • "empty":
      boolean
    }
  • "entity":
    object
  • "lastModified":
    string
    Format: date-time
  • "date":
    string
    Format: date-time
  • "headers":
    object
    {
    • "empty":
      boolean
    }
  • "cookies":
    object
  • "status":
    integer
    Format: int32
  • "length":
    integer
    Format: int32
  • "language":
    object
    {
    • "language":
      string
    • "script":
      string
    • "country":
      string
    • "variant":
      string
    • "extensionKeys":
      array
      An array of string literals.
    • "unicodeLocaleAttributes":
      array
      An array of string literals.
    • "unicodeLocaleKeys":
      array
      An array of string literals.
    • "iso3Language":
      string
    • "iso3Country":
      string
    • "displayLanguage":
      string
    • "displayScript":
      string
    • "displayCountry":
      string
    • "displayVariant":
      string
    • "displayName":
      string
    }
  • "location":
    string
    Format: uri
}

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