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:
Note: Only one currency is returned per request (either explicitly specified as a matrix parameter or, if missing, the application's default currency is used).
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,java.lang.String,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. | |
in query | shipFromAddress | string | SX6sEQAFMaYAAAF33DhZTnFf | The ID or URN of a specific sender address. Allows to retrieve prices based on country-specific taxes for the given sender address. | |
in query | shipToAddress | string | QdasEQAFJKAAAAF3o89ZTnFf | The ID or URN of a specific shipping address. Allows to retrieve prices based on country-specific taxes for the given shipping address. |
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