Document Tree
Document Properties
Kbid
2A9995
Last Modified
09-Nov-2022
Added to KB
28-Oct-2021
Public Access
Everyone
Status
Online
Doc Type
References
Product
  • ICM 7.10
  • ICM 11
  • ICM 12
Reference - Quoting REST API 1.1.0


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

References

The following page lists available REST APIs for ICM 7.10 and their version dependencies:

API Specification

openapi: 3.0.1 info: title: Quoting description: "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.\n" version: 1.1.0 servers: - url: "/INTERSHOP/rest/{serverGroup}/{siteName}/{appUrl}" description: Intershop ICM Server variables: serverGroup: description: The server group default: WFS siteName: description: The site name default: inSPIRED-inTRONICS-Site appUrl: description: The application URL identifier enum: - smb-responsive - "-" default: smb-responsive tags: - name: Quote Request description: "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.\n" x-priority: "60" x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemResource - name: Quote description: "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.\n" x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource paths: /customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests: get: tags: - Quote Request summary: 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". operationId: getQuoteRequests parameters: - name: attrs in: query description: "The following attributes are available:\n- `number` - The quote\ \ request number\n- `name` - Name of the quote request\n- `lineItems` -\ \ Number of line items contained in the quote request (a line item might\ \ have multiple quantities)\n- `creationDate` - Date on which the quote\ \ request was created\n- `submittedDate` - Date on which the quote request\ \ was submitted; missing if the quote request has not yet been submitted\n\ - `editable` - Flag indicating whether the quote request is editable\n-\ \ `submitted` - Flag indicating whether the quote request is submitted\n\ \nUse a comma-separated list for multiple values e.g. \"`attrs=number,name`\"\ .\n" schema: type: string description: "The following attributes are available:\n- `number` - The\ \ quote request number\n- `name` - Name of the quote request\n- `lineItems`\ \ - Number of line items contained in the quote request (a line item might\ \ have multiple quantities)\n- `creationDate` - Date on which the quote\ \ request was created\n- `submittedDate` - Date on which the quote request\ \ was submitted; missing if the quote request has not yet been submitted\n\ - `editable` - Flag indicating whether the quote request is editable\n\ - `submitted` - Flag indicating whether the quote request is submitted\n\ \nUse a comma-separated list for multiple values e.g. \"`attrs=number,name`\"\ .\n" - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionRO' "403": description: Forbidden "404": description: Not found "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource.getQuoteRequests(java.lang.String) x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource post: tags: - Quote Request summary: 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. \n\n\nThe following parameters are available (please provide\ \ at most **one** parameter):\n\n- *no parameter* - Empty quote request\n\ - `quoteID` - Quote request based on existing quote: Provide quote ID\n- `quoteRequestID`\ \ - Quote request based on existing quote request: Provide quote request ID\n\ - `basketID` - Quote request based on existing basket: Provide basket ID\n\ \n\nNote: The parameter \"newQuoteRequestRO\" is deprecated and should not\ \ be used anymore. Use query parameters \"quoteID\", \"basketID\" or \"quoteRequestID\"\ \ instead.\n" operationId: createQuoteRequest parameters: - name: quoteID in: query description: The ID of the quote. Used to create a quote request based on an existing quote. schema: type: string description: The ID of the quote. Used to create a quote request based on an existing quote. - name: basketID in: query description: The ID of the basket. Used to create a quote request based on an existing basket. schema: type: string description: The ID of the basket. Used to create a quote request based on an existing basket. - name: quoteRequestID in: query description: The ID of the quote request. Used to create a quote request based on an existing quote request. schema: type: string description: The ID of the quote request. Used to create a quote request based on an existing quote request. - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource requestBody: description: Deprecated - Use query parameters "quoteID" and "basketID" instead. content: application/json: schema: $ref: '#/components/schemas/NewQuoteRequestRO' text/xml: schema: $ref: '#/components/schemas/NewQuoteRequestRO' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' "400": description: Bad request "403": description: Forbidden "404": description: Not found "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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)" x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource /customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests/{UserQuoteRequestsKey}: get: tags: - Quote Request summary: 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. operationId: getQuoteRequestDetails parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource - name: UserQuoteRequestsKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/QuoteRequestRO' text/xml: schema: $ref: '#/components/schemas/QuoteRequestRO' "303": description: See other Link to the created quote because the request quote request has become a quote. content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' "403": description: Forbidden - A user with insufficient permissions tries to access the quote request or the quote request is not editable. "404": description: Not found - A quote request with the given UserQuoteRequestsKey is not found. "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsItemResource.getQuoteRequestDetails() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsItemResource put: tags: - Quote Request summary: 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.\n" operationId: updateQuoteRequest parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource - name: UserQuoteRequestsKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource requestBody: description: A quote request. content: application/json: schema: $ref: '#/components/schemas/QuoteRequestRO' text/xml: schema: $ref: '#/components/schemas/QuoteRequestRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/QuoteRequestRO' text/xml: schema: $ref: '#/components/schemas/QuoteRequestRO' "403": description: Forbidden - A user with insufficient permissions tries to access the quote request or the quote request is not editable. "404": description: Not found - A quote request with the given UserQuoteRequestsKey is not found. "401": description: Unauthorized "400": description: "Bad request, if no data to update is provided" security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsItemResource delete: tags: - Quote Request summary: Delete a quote request description: | This operation deletes a quote request based on the provided parameters. operationId: deleteQuoteRequest parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource - name: UserQuoteRequestsKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource responses: "204": description: No content "403": description: Forbidden - A user with insufficient permissions to access the quote request or the quote request is not editable. "404": description: Not found - A quote request with the given UserQuoteRequestsKey is not found. "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsItemResource.deleteQuoteRequest() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsItemResource /customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests/{UserQuoteRequestsKey}/items: get: tags: - Quote Request summary: Returns line items of a quote request description: | This operation returns a list of line items for the quote request with the specified UserQuoteRequestsKey. operationId: getQuoteRequestLineItems parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource - name: UserQuoteRequestsKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionRO' "403": description: Forbidden - A user with insufficient permissions tries to access the quote request or the quote request is not editable. "404": description: Not found - A quote request with the given UserQuoteRequestsKey is not found. "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemListResource.getQuoteRequestLineItems() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemListResource put: tags: - Quote Request summary: Sets the list of quote line items description: "This operation sets the list of quote line items when the quote\ \ request is editable. If there are already items in the list, they will be\ \ replaced by the new list. Each product is validated before it can be added.\n\ \nA 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).\nIf a product that\ \ should be added is a bundle product, all parts are added to the quote separately.\n\ Additionally, a field status indicates whether there were failures (values\ \ \"SUCCESS\", \"ERROR\").\n" operationId: setQuoteLineItems parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource - name: UserQuoteRequestsKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource requestBody: description: List of quote line items. content: application/json: schema: $ref: '#/components/schemas/QuoteRequestLineItemROResourceCollection' text/xml: schema: $ref: '#/components/schemas/QuoteRequestLineItemROResourceCollection' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/QuoteLineItemResultRO' text/xml: schema: $ref: '#/components/schemas/QuoteLineItemResultRO' "403": description: Forbidden - A user with insufficient permissions tries to access the quote request or the quote request is not editable. "404": description: Not found - A quote request with the given UserQuoteRequestsKey is not found. "401": description: Unauthorized "400": description: Bad request security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemListResource post: tags: - Quote Request summary: 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.\nIf the product to be added is a bundle product, all\ \ parts are added separately to the quote.\n\nIf only one quote line item\ \ is created, this operation returns a link to the created line item. In this\ \ case, the link contains the ID of the line item in the field \"itemId\"\ \ (and also in the \"title\").\n\nFor a product bundle, multiple quote line\ \ items are created. In this case, this operation returns a link to the line\ \ item list (/items). The \"itemId\" is not set and the title contains the\ \ message \"multiple items added\".\n\nIn case not all bundled products are\ \ available, only valid products will be added.\n" operationId: createQuoteLineItem parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource - name: UserQuoteRequestsKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource requestBody: description: Quote request line item values. content: application/json: schema: $ref: '#/components/schemas/QuoteRequestLineItemRO' text/xml: schema: $ref: '#/components/schemas/QuoteRequestLineItemRO' responses: "201": description: Created content: application/json: schema: $ref: '#/components/schemas/LinkRO' text/xml: schema: $ref: '#/components/schemas/LinkRO' "400": description: "Bad request, if no data for the line item is provided or validation\ \ of product failed" "403": description: Forbidden - A user with insufficient permissions tries to access the quote request or the quote request is not editable. "404": description: Not found - A quote request with the given UserQuoteRequestsKey is not found. "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemListResource /customers/{CustomerKey}/users/{CustomerItemUserKey}/quoterequests/{UserQuoteRequestsKey}/items/{UserQuoteRequestsLineKey}: get: tags: - Quote Request summary: Returns a line item of a quote request description: "This operation returns a line item of a quote request, based on\ \ the provided parameters.\n" operationId: getQuoteRequestLineItemDetails parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource - name: UserQuoteRequestsKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource - name: UserQuoteRequestsLineKey in: path description: The key or UUID to resolve a single item required: true schema: type: string description: The key or UUID to resolve a single item example: ExampleKey example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/QuoteRequestLineItemRO' text/xml: schema: $ref: '#/components/schemas/QuoteRequestLineItemRO' "403": description: Forbidden "404": description: Not found "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemResource.getQuoteRequestLineItemDetails() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemResource put: tags: - Quote Request summary: 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).\n" operationId: updateQuoteRequestLineItem parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource - name: UserQuoteRequestsKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource - name: UserQuoteRequestsLineKey in: path description: The key or UUID to resolve a single item required: true schema: type: string description: The key or UUID to resolve a single item example: ExampleKey example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemListResource requestBody: description: Quote request line item values. content: application/json: schema: $ref: '#/components/schemas/QuoteRequestLineItemRO' text/xml: schema: $ref: '#/components/schemas/QuoteRequestLineItemRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/QuoteRequestLineItemRO' text/xml: schema: $ref: '#/components/schemas/QuoteRequestLineItemRO' "403": description: Forbidden "404": description: Not found "401": description: Unauthorized "400": description: Bad request security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemResource delete: tags: - Quote Request summary: 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).\n" operationId: deleteQuoteRequestLineItem parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource - name: UserQuoteRequestsKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource - name: UserQuoteRequestsLineKey in: path description: The key or UUID to resolve a single item required: true schema: type: string description: The key or UUID to resolve a single item example: ExampleKey example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemListResource responses: "204": description: No content "403": description: Forbidden "404": description: Not found "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemResource.deleteQuoteRequestLineItem() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsLineItemResource /customers/{CustomerKey}/users/{CustomerItemUserKey}/quotes: get: tags: - Quote summary: Retrieves a list of quotes description: "" operationId: getQuotes parameters: - name: state in: query description: | Possible states: - `RESPONDED` - `REJECTED` schema: type: string description: | Possible states: - `RESPONDED` - `REJECTED` - name: attrs in: query description: "The following attributes are available:\n- `number` - The quote\ \ number\n- `name` - Name of the quote\n- `lineItems` - Number of line items\ \ contained in the quote (a line item might have multiple quantities)\n\ - `creationDate` - Date on which the quote was created\n- `validFromDate`\ \ - Begin of the quote's period of validity\n- `validToDate` - End of the\ \ quote's period of validity\n- `rejected` - Flag indicating whether the\ \ quote is rejected (by end user)\n\nUse a comma-separated list for multiple\ \ values e.g. \"`attrs=number,name`\".\n" schema: type: string description: "The following attributes are available:\n- `number` - The\ \ quote number\n- `name` - Name of the quote\n- `lineItems` - Number of\ \ line items contained in the quote (a line item might have multiple quantities)\n\ - `creationDate` - Date on which the quote was created\n- `validFromDate`\ \ - Begin of the quote's period of validity\n- `validToDate` - End of\ \ the quote's period of validity\n- `rejected` - Flag indicating whether\ \ the quote is rejected (by end user)\n\nUse a comma-separated list for\ \ multiple values e.g. \"`attrs=number,name`\".\n" - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCollectionRO' text/xml: schema: $ref: '#/components/schemas/ResourceCollectionRO' "403": description: Forbidden "404": description: Not found "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: "public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesListResource.getQuotes(java.lang.String,java.lang.String)" x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesListResource post: tags: - Quote summary: Submits a quote request description: "" operationId: submitQuoteRequest parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitQuoteRequestRO' text/xml: schema: $ref: '#/components/schemas/SubmitQuoteRequestRO' responses: "202": description: Accepted "403": description: Forbidden "404": description: Not found "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesListResource /customers/{CustomerKey}/users/{CustomerItemUserKey}/quotes/{UserQuotesKey}: get: tags: - Quote summary: Returns details of a quote description: | This operation returns details of a quote. operationId: getQuoteDetails parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource - name: UserQuotesKey in: path description: The key or UUID to resolve a single item required: true schema: type: string description: The key or UUID to resolve a single item example: ExampleKey example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesListResource responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/QuoteRO' text/xml: schema: $ref: '#/components/schemas/QuoteRO' "403": description: Forbidden "404": description: Not found "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource.getQuoteDetails() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource put: tags: - Quote summary: 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.\n" operationId: updateQuote parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource - name: UserQuotesKey in: path description: The key or UUID to resolve a single item required: true schema: type: string description: The key or UUID to resolve a single item example: ExampleKey example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesListResource requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateQuoteRO' text/xml: schema: $ref: '#/components/schemas/UpdateQuoteRO' responses: "200": description: OK content: application/json: schema: $ref: '#/components/schemas/QuoteRO' text/xml: schema: $ref: '#/components/schemas/QuoteRO' "400": description: Bad request "403": description: Forbidden "404": description: Not found "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-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) x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource delete: tags: - Quote summary: Deletes a quote description: | This operation deletes a quote based on the provided parameters. operationId: deleteQuote parameters: - name: CustomerKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.customer.CustomerListResource - name: CustomerItemUserKey in: path description: The key or UUID to resolve a single item required: true schema: type: string example: ExampleKey x-item-key: com.intershop.sellside.rest.smb.capi.resource.user.CustomerItemUserListResource - name: UserQuotesKey in: path description: The key or UUID to resolve a single item required: true schema: type: string description: The key or UUID to resolve a single item example: ExampleKey example: ExampleKey x-item-key: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesListResource responses: "204": description: No content "403": description: Forbidden "404": description: Not found "401": description: Unauthorized security: - bearerAuth: [] - basicAuth: [] - authToken: [] x-origin-method: public javax.ws.rs.core.Response com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource.deleteQuote() x-origin-class: com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesItemResource components: schemas: LinkRO: title: Link type: object properties: name: type: string description: The name of the returned element xml: attribute: true type: type: string description: "This is a constant: **Link**" readOnly: true example: Link xml: attribute: true attributes: type: array description: The list of attributes xml: wrapped: true items: $ref: '#/components/schemas/ResourceAttribute' uri: type: string description: The URI relation: type: string description: The relation of the link externalDocs: description: Link Relations (www.iana.org) url: http://www.iana.org/assignments/link-relations/link-relations.xml enum: - 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 title: type: string description: The title of the link description: type: string description: The description of the link itemId: type: string description: The ID of the linked item attribute: $ref: '#/components/schemas/ResourceAttribute' description: A Link pointing to a resource xml: name: Link ResourceAttribute: title: Attribute type: object properties: name: type: string description: The attribute's name xml: attribute: true type: type: string description: "This is a constant: **ResourceAttribute**" example: ResourceAttribute xml: attribute: true value: type: object description: The attribute's value. description: An attribute xml: name: ResourceAttribute NewQuoteRequestRO: title: NewQuoteRequest type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true quoteID: type: string description: The ID of the quote example: mwnAqMgoQWUAAAE8irJXwIE5 basketID: type: string description: The ID of the basket example: n8YKDgAhNVQAAAFTQKgS.DdF description: Quote requests holds 'quoteID' and the 'basketID' for new quote request. xml: name: NewQuoteRequest AbstractResourceObject: title: Object type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true description: The list of elements ResourceCollectionRO: type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/AbstractResourceObject' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of an element xml: attribute: true description: A list of ResourceObjects xml: name: ResourceCollection MoneyRO: title: Money type: object properties: type: type: string description: "This is a constant: **Money**" readOnly: true example: Money xml: attribute: true value: type: number description: The monetary value. example: 10.99 currencyMnemonic: type: string deprecated: true currency: type: string description: Three-letter currency code (ISO 4217) of the monetary value. example: USD description: Money combines a currency and a money amount. xml: name: Money QuoteRequestRO: title: QuoteRequestRO type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true displayName: type: string description: The display name of the quote request example: "0000101" id: type: string description: The ID of the quote request example: 59sKDgAho9UAAAFUFy0h_DO6 number: type: string description: The number of the quote request example: "0000101" description: type: string description: The description of the quote request example: description editable: type: boolean description: Indicates whether the quote request is editable example: true submitted: type: boolean description: Indicates whether the quote request is submitted example: true creationDate: type: string description: The creation date of the quote request format: date-time submittedDate: type: string description: The date the quote request was submitted format: date-time total: $ref: '#/components/schemas/MoneyRO' items: type: array description: A list of all items for the given quote request as LinkROs xml: wrapped: true items: $ref: '#/components/schemas/LinkRO' description: This resource holds information about a quote request. xml: name: QuoteRequest QuantityRO: title: Quantity type: object properties: type: type: string description: "This is a constant: **Quantity**" readOnly: true example: Quantity xml: attribute: true value: type: number description: The quantity's value example: 10.99 unit: type: string description: The quantity's ISO unit code. example: PIEC description: Quantity combines a quantity value and the ISO unit code the value is defined in. xml: name: Quantity QuoteRequestLineItemRO: title: QuoteRequestLineItemRO type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true quantity: $ref: '#/components/schemas/QuantityRO' singlePrice: $ref: '#/components/schemas/MoneyRO' totalPrice: $ref: '#/components/schemas/MoneyRO' productSKU: type: string description: The product SKU example: "9438012" id: type: string description: The ID of the quote request line item example: XW.sGLABFUgAAAFu67ET4H2R description: This resource holds information on the quote request line item. xml: name: QuoteRequestLineItem QuoteLineItemResultRO: title: QuoteLineItemResultRO type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true failedProductSKUs: type: array description: The product SKUs of the failed products xml: wrapped: true items: type: string xml: name: sku status: type: string description: Indicates whether the result contains failed products example: "SUCCESS,ERROR" description: This resource holds status information about the PUT operation for the quote line items. xml: name: QuoteLineItemResult QuoteRequestLineItemROResourceCollection: title: QuoteRequestLineItemROResourceCollection type: object properties: pageable: type: string description: The pageable ID total: type: integer description: The pageable amount total format: int32 offset: type: integer description: The pageable offset format: int32 amount: type: integer description: The pageable amount format: int32 elements: type: array description: The list of elements xml: wrapped: true items: $ref: '#/components/schemas/QuoteRequestLineItemRO' type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' xml: attribute: true sortKeys: uniqueItems: true type: array description: The keys to sort for xml: wrapped: true items: type: string description: The keys to sort for xml: name: sortKey name: type: string description: The name of an element xml: attribute: true description: This resource holds sets of quote request line items. xml: name: QuoteRequestLineItemCollection SubmitQuoteRequestRO: title: SubmitQuoteRequestRO type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true quoteRequestID: type: string description: The quote request ID. example: OmwKDgAhF5IAAAFTgy8bsDHK description: This resource holds information about the submitted quote. xml: name: QuoteRequest QuoteLineItemRO: title: QuoteLineItemRO type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true originQuantity: $ref: '#/components/schemas/QuantityRO' originSinglePrice: $ref: '#/components/schemas/MoneyRO' originTotalPrice: $ref: '#/components/schemas/MoneyRO' quantity: $ref: '#/components/schemas/QuantityRO' singlePrice: $ref: '#/components/schemas/MoneyRO' totalPrice: $ref: '#/components/schemas/MoneyRO' productSKU: type: string description: The product SKU example: "9438012" description: This resource holds information on the quote line item. xml: name: QuoteLineItem QuoteRO: title: QuoteRO type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true items: type: array description: The line items of the quote as collection of QuoteLineItemROs items: $ref: '#/components/schemas/QuoteLineItemRO' displayName: type: string description: The display name of a quote example: new name... id: type: string description: The ID of a quote example: 59sKDgAho9UAAAFUFy0h_DO6 number: type: string description: The number of a quote example: "0000101" description: type: string description: The description of a quote example: new description... creationDate: type: string description: The creation date of a quote format: date-time validFromDate: type: string description: The valid from date of a quote format: date-time validToDate: type: string description: The valid to date of a quote format: date-time sellerComment: type: string description: Comment of the seller on a quote example: Only 1 week valid! rejected: type: boolean description: Indicates whether the quote is rejected example: true originTotal: $ref: '#/components/schemas/MoneyRO' total: $ref: '#/components/schemas/MoneyRO' description: This resource holds information about a quote. xml: name: Quote UpdateQuoteRO: title: UpdateQuoteRO type: object properties: name: type: string description: The name of an element xml: attribute: true type: type: string description: 'The type of the element. This is normally a **constant** that can be used to differentiate elements by their type. ' readOnly: true xml: attribute: true rejected: type: boolean description: Indicates whether the quote is rejected example: true description: This resource holds information about a quote to be updated. xml: name: Quote responses: "200": description: OK "201": description: Created "202": description: Accepted "204": description: No Content "205": description: Reset Content "206": description: Partial Content "301": description: Moved Permanently "302": description: Found "303": description: See Other "304": description: Not Modified "305": description: Use Proxy "307": description: Temporary Redirect "400": description: Bad Request "401": description: Unauthorized "402": description: Payment Required "403": description: Forbidden "404": description: Not Found "405": description: Method Not Allowed "406": description: Not Acceptable "407": description: Proxy Authentication Required "408": description: Request Timeout "409": description: Conflict "410": description: Gone "411": description: Length Required "412": description: Precondition Failed "413": description: Request Entity Too Large "414": description: Request-URI Too Long "415": description: Unsupported Media Type "416": description: Requested Range Not Satisfiable "417": description: Expectation Failed "428": description: Precondition Required "429": description: Too Many Requests "431": description: Request Header Fields Too Large "500": description: Internal Server Error "501": description: Not Implemented "502": description: Bad Gateway "503": description: Service Unavailable "504": description: Gateway Timeout "505": description: HTTP Version Not Supported "511": description: Network Authentication Required parameters: loc: name: loc in: path description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using a\ \ underscore, e. g. ```en_US```." required: false style: matrix schema: type: string description: "The locale ID (submitted as optional matrix parameter ```;loc=```).\ \ If omitted, the priority is as follows (from high to low): Locale ID parameter,\ \ user's default locale, site's default locale. The available locales depend\ \ on your individual Intershop Commerce Management installation. Use IANA\ \ language definitions for languages and regions and combine them using\ \ a underscore, e. g. ```en_US```." default: en_US examples: en_US: description: English (United States) value: en_US fr_FR: description: French (France) value: fr_FR de_DE: description: German (Germany) value: de_DE x-matrixParamPath: / cur: name: cur in: path description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." required: false style: matrix schema: type: string description: "The currency code (submitted as optional matrix parameter ```;cur=```).\ \ If omitted, the site's or user's default currency is used." default: USD examples: FJD: description: Fiji Dollar value: FJD STD: description: São Tomé / Príncipe Dobra value: STD MXN: description: Mexican Peso value: MXN SCR: description: Seychelles Rupee value: SCR LVL: description: Latvian Lats value: LVL CDF: description: Congolese Franc value: CDF GTQ: description: Guatemalan Quetzal value: GTQ BBD: description: Barbados Dollar value: BBD CLP: description: Chilean Peso value: CLP UGX: description: Ugandan Shilling value: UGX HNL: description: Honduran Lempira value: HNL ZAR: description: South African Rand value: ZAR TND: description: Tunisian Dinar value: TND SLL: description: Sierra Leonean Leone value: SLL BSD: description: Bahamian Dollar value: BSD SDG: description: Sudanese Pound value: SDG IQD: description: Iraqi Dinar value: IQD GMD: description: Gambian Dalasi value: GMD CUP: description: Cuban Peso value: CUP TWD: description: New Taiwan Dollar value: TWD RSD: description: Serbian Dinar value: RSD ZRZ: description: Zaire value: ZRZ DOP: description: Dominican Peso value: DOP KMF: description: Comoro Franc value: KMF MYR: description: Malaysian Ringgit value: MYR FKP: description: Falkland Islands Pound value: FKP XOF: description: CFA Franc BCEAO value: XOF GEL: description: Lari value: GEL UYU: description: Uruguayan Peso value: UYU MAD: description: Moroccan Dirham value: MAD CVE: description: Cape Verde Escudo value: CVE TOP: description: Tongan Pa'anga value: TOP PGK: description: Papua New Guinean Kina value: PGK OMR: description: Omani Rial value: OMR AZN: description: Azerbaijanian Manat value: AZN SEK: description: Swedish Krona value: SEK KES: description: Kenyan Shilling value: KES UAH: description: Ukrainian Hryvnia value: UAH BTN: description: Ngultrum value: BTN GNF: description: Guinea Franc value: GNF MZN: description: Mozambican Metical value: MZN ERN: description: Nakfa value: ERN SVC: description: Salvadoran Colón value: SVC ARS: description: Argentine Peso value: ARS QAR: description: Qatari Riyal value: QAR NLG: description: Dutch Guilder value: NLG IRR: description: Iranian Rial value: IRR MRO: description: Mauritanian Ouguiya value: MRO XPF: description: CFP Franc value: XPF UZS: description: Uzbekistani Som value: UZS THB: description: Thai Baht value: THB CNY: description: Yuan Renminbi value: CNY BDT: description: Bangladeshi Taka value: BDT LYD: description: Libyan Dinar value: LYD BMD: description: Bermudian Dollar value: BMD PHP: description: Philippine Peso value: PHP KWD: description: Kuwaiti Dinar value: KWD RUB: description: Russian Ruble value: RUB PYG: description: Paraguayan Guarani value: PYG JMD: description: Jamaican Dollar value: JMD ISK: description: Iceland Krona value: ISK GWP: description: Guinea Peso value: GWP BEF: description: Belgian Franc value: BEF ESP: description: Spanish Peseta value: ESP COP: description: Colombian Peso value: COP USD: description: US Dollar value: USD MKD: description: Denar value: MKD DZD: description: Algerian Dinar value: DZD PAB: description: Panamanian Balboa value: PAB SGD: description: Singapore Dollar value: SGD ETB: description: Ethiopian Birr value: ETB VUV: description: Vanuatu Vatu value: VUV VEF: description: Venezuelan Bolivar Fuerte value: VEF SOS: description: Somali Shilling value: SOS KGS: description: Som value: KGS LAK: description: Lao Kip value: LAK ZMK: description: Zambian Kwacha value: ZMK BND: description: Brunei Dollar value: BND XAF: description: CFA Franc BEAC value: XAF LRD: description: Liberian Dollar value: LRD ITL: description: Italian Lira value: ITL HRK: description: Croatian Kuna value: HRK CHF: description: Swiss Franc value: CHF ATS: description: Austrian Schilling value: ATS DJF: description: Djibouti Franc value: DJF ALL: description: Albanian Lek value: ALL MTL: description: Maltese Lira value: MTL TZS: description: Tanzanian Shilling value: TZS VND: description: Vietnamese Dong value: VND AUD: description: Australian Dollar value: AUD ILS: description: New Israeli Sheqel value: ILS KPW: description: North Korean Won value: KPW GYD: description: Guyanese Dollar value: GYD GHS: description: Ghanaian Cedi value: GHS MDL: description: Moldovan Leu value: MDL KHR: description: Cambodian Riel value: KHR BOB: description: Boliviano value: BOB IDR: description: Indonesian Rupiah value: IDR KYD: description: Cayman Islands Dollar value: KYD AMD: description: Armenian Dram value: AMD TRY: description: Turkish Lira value: TRY SHP: description: Saint Helena Pound value: SHP BWP: description: Botswana Pula value: BWP LBP: description: Lebanese Pound value: LBP CYP: description: Cyprus Pound value: CYP TJS: description: Tajikistani Somoni value: TJS JOD: description: Jordanian Dinar value: JOD RWF: description: Rwanda Franc value: RWF HKD: description: Hong Kong Dollar value: HKD AED: description: United Arab Emirates Dirham value: AED EUR: description: Euro value: EUR LSL: description: Lesotho Loti value: LSL DKK: description: Danish Krone value: DKK CAD: description: Canadian Dollar value: CAD BGN: description: Bulgarian Lev value: BGN MMK: description: Kyat value: MMK EEK: description: Estonian Kroon value: EEK SYP: description: Syrian Pound value: SYP NOK: description: Norwegian Krone value: NOK MUR: description: Mauritian Rupee value: MUR ZWL: description: Zimbabwean Dollar value: ZWL GIP: description: Gibraltar Pound value: GIP RON: description: Romanian New Leu value: RON LKR: description: Sri Lankan Rupee value: LKR NGN: description: Nigerian Naira value: NGN IEP: description: Irish Pound value: IEP CZK: description: Czech Koruna value: CZK CRC: description: Costa Rican Colon value: CRC PKR: description: Pakistani Rupee value: PKR XCD: description: East Carribean Dollar value: XCD GRD: description: Greek Drachma value: GRD HTG: description: Haitian Gourde value: HTG ANG: description: Netherlands Antillian Guilder value: ANG SIT: description: Slovenian Tolar value: SIT BHD: description: Bahraini Dinar value: BHD PTE: description: Portuguese Escudo value: PTE BPP: description: Bonus Point Price value: BPP SZL: description: Swazi Lilangeni value: SZL SRD: description: Surinam Dollar value: SRD KZT: description: Kazakhstani Tenge value: KZT TTD: description: Trinidad and Tobago Dollar value: TTD SAR: description: Saudi Riyal value: SAR LTL: description: Lithuanian Litas value: LTL YER: description: Yemeni Rial value: YER MVR: description: Maldivian Rufiyaa value: MVR BPV: description: Bonus Point Value value: BPV AFN: description: Afghani value: AFN INR: description: Indian Rupee value: INR NPR: description: Nepalese Rupee value: NPR KRW: description: South Korean Won value: KRW AWG: description: Aruban Florin value: AWG MNT: description: Mongolian Tugrik value: MNT JPY: description: Japanese Yen value: JPY PLN: description: Polish Złoty value: PLN AOA: description: Angolan Kwanza value: AOA SBD: description: Solomon Islands Dollar value: SBD GBP: description: Pound Sterling value: GBP HUF: description: Hungarian Forint value: HUF BYR: description: Belarussian Ruble value: BYR LUF: description: Luxembourgian Franc value: LUF BIF: description: Burundi Franc value: BIF MWK: description: Malawian Kwacha value: MWK MGA: description: Malagasy Ariary value: MGA FIM: description: Finnish Mark value: FIM DEM: description: Deutsche Mark value: DEM BZD: description: Belize Dollar value: BZD BAM: description: Convertible Marks value: BAM MOP: description: Macanese Pataca value: MOP EGP: description: Egyptian Pound value: EGP NAD: description: Namibian Dollar value: NAD SKK: description: Slovakian Krona value: SKK NIO: description: Cordoba Oro value: NIO PEN: description: Peruvian Nuevo Sol value: PEN WST: description: Samoan Tala value: WST NZD: description: New Zealand Dollar value: NZD TMT: description: Turkmenistani Manat value: TMT FRF: description: French Franc value: FRF BRL: description: Brazilian Real value: BRL x-matrixParamPath: / regionals: name: regionals in: path required: false style: matrix schema: type: object properties: loc: type: string description: The locale ID example: en_US cur: type: string description: The currency code example: EUR x-matrixParamPath: / pgid: name: pgid in: path description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The personalization group identifier, submitted as matrix parameter\ \ ```;pgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 spgid: name: spgid in: path description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." required: false style: matrix schema: type: string description: "The secure personalization group identifier, submitted as matrix\ \ parameter ```;spgid=```. Required if you want to work with customer-specific\ \ content." example: FUOGrzQ_VjORpGaN8DRGmLLE0000 example: FUOGrzQ_VjORpGaN8DRGmLLE0000 securitySchemes: basicAuth: type: http description: "Basic access authentication. In basic authentication, a request\ \ contains a header field in the form of authorization: ```Basic ```,\ \ where credentials is the Base64 encoding of ID and password joined by a\ \ single colon :." scheme: basic authToken: type: apiKey description: User authentication token to authenticate the request. The token is a string generated by the ICM server in the same header in every response of an REST endpoint. name: authentication-token in: header bearerAuth: type: http description: "Bearer token authentication. A request contains a header field\ \ in the form of authorization: ```Bearer ```, where is a string\ \ generated by an authentication service in response to a login request." scheme: bearer bearerFormat: JWT x-apiID: quoting x-origin-class: "com.intershop.component.rest.capi.resource.RootResource,com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuoteRequestsListResource,com.intershop.application.storefront.rest.b2b.capi.quote.resource.UserQuotesListResource"

Open ReDoc-rendered Open API documentation in separate window.

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.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.