This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 7.10 and their version dependencies:
This section covers operations related to product prices.
{cur}/productprices
This operation returns prices for one or more products including scaled prices. It is possible to get prices by:
public javax.ws.rs.core.Response com.intershop.sellside.rest.pricing.v1.capi.resource.ProductPriceResource.getPrices(java.util.List,java.util.List,java.util.List,java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | cur | string | USD | The currency code (submitted as optional matrix parameter ;cur=<CURRENCY> ). If omitted, the site's or user's default currency is used. | |
in query | sku | array | 4810740 | Required | The product SKU(s) (one or multiple values: sku=...&sku=...) | |
in query | priceListType | array | ListPrice | SalePrice | The type of price list (one or multiple values: priceListType=...&priceListType=...). If missing, the standard price list types "ListPrice" and "SalePrice" are returned. | |
in query | priceType | array | net | gross | The price display type "net" and/or "gross" (one or multiple values: priceType=net&priceType=gross). If missing, the standard price types "net" and "gross" are returned. | |
in query | customerID | string | Heimroth | OilCorp | The customer ID to get product prices for this particular customer. This requires authorization. |
200 - OK - The prices were successfully retrieved.
401 - Unauthorized - The user could not be authenticated.
403 - Forbidden - The user does not have the required permissions.
422 - Unprocessable Entity
ProductPriceContainerRO
objects. The core data of the response object.ProductPriceContainerRO
: Price container for one product that holds prices.FeedbackRO_v1
objects. List of errors that occurred in relation to the request.FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
FeedbackRO_v1
objects. List of informations regarding to the request (e.g. value adjustments).FeedbackRO_v1
: An error or information representation regarding the current request.FeedbackCauseRO_v1
objects. A collection of errors/infos that caused this feedback.FeedbackCauseRO_v1
: A representation for the common feedback informations.invoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPathinvoiceToAddress.address.postalcode.invalid
The specified postal code is invalid. Valid values are numbers 10000 to 99999.
string
literals. A collection of JSON paths to the associated entities. If not otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath400
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.