Personal Library

Reference - Pricing API 1.0.0 (Beta)

https://support.intershop.com/kb/29912Z

Share this document

ReDoc View
Document View

Product Version	7.10
Product To Version
Status	Final

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

icm-pricing-1x0x0.yaml

References

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

Reference - Intershop Commerce Management 7.10 REST API

API Specification

Introduction

OpenAPI Version: 3.0.1

Pricing Version: 1.0.0-beta

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.

Product Prices API

This section covers operations related to product prices.

{cur}/productprices

GET: [BETA] Returns prices for one or more products

Description

This operation returns prices for one or more products including scaled prices. It is possible to get prices by:

priceListType - Returns prices from different priceList types "ListPrice" or "SalePrice" or both (default). Custom priceListTypes can also be retrieved (if whitelisted).
priceType - Returns prices either in "net", "gross" or both (default).
customerID - Returns customer-specific prices based on the customerID.
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).

Java Method

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)

Request Body

Request Parameters

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.

Response

200 - OK - The prices were successfully retrieved.

ProductPriceContainerCtnrRO_v1 application/vnd.intershop.pricing.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user does not have the required permissions.

422 - Unprocessable Entity

Request and Response Object Schemata

ProductPriceContainerCtnrRO_v1 application/vnd.intershop.pricing.v1+json

{

"data":
array
An array of ProductPriceContainerRO objects. The core data of the response object.
[
ProductPriceContainerRO: Price container for one product that holds prices.
{
- "sku":
  string
- "prices":
  object
}
]
"errors":
array
Readonly | An array of FeedbackRO_v1 objects. List of errors that occurred in relation to the request.
[
FeedbackRO_v1: An error or information representation regarding the current request.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of 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/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of 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/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"included":
object
Optionally included related data objects.
"infos":
array
Readonly | An array of 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.
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/infos that caused this feedback.
  [
  FeedbackCauseRO_v1: A representation for the common feedback informations.
  {
  "code":
  string
  Required | An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
  "message":
  string
  Required | A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
  "parameters":
  object
  A map of several parameters that are used to assemble the message.
  "paths":
  array
  An array of 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/JsonPath
  }
  ]
- "code":
  string
  An unique identifier for this particular occurrence of the problem (may be used for localization on client-side). | Example: invoiceToAddress.address.postalcode.invalid
- "message":
  string
  A human readable message in request's locale (server falls back to lead locale if requested local is not supported). | Example: The specified postal code is invalid. Valid values are numbers 10000 to 99999.
- "parameters":
  object
  A map of several parameters that are used to assemble the message.
- "paths":
  array
  An array of 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/JsonPath
- "status":
  string
  The HTTP status code, that is applicable to this problem. | Example: 400
}
]
"links":
object
Readonly | Map of links to this and the optionally included related data objects. The object in the "data" property is always referenced by identifier "self". Note that this identifier may also contain a list of URIs, if the data block contains multiple elements.

}

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.