Reference

API Specification

Introduction

OpenAPI Version: 3.0.1

Price Service Webhook Version: 1.0.0-Beta

The Price Service Webhook supports the request of prices from another system.

Miscellaneous API

/[path to product price service]

POST: [BETA] Retrieves product prices

Description

This operation retrieves the prices for the given product IDs. The request supports up to three additional header and query parameters, where key and value can both be customized.

The minQuantity of a price is only optional if it is 1.

Request Body

ProductPriceRequest application/json

Request Parameters

Location	Name	Format	Default	Example	Description
in header	tenant-id	string		`inSPIRED`	ID to identify the sender

Response

200 - OK - The prices have been retrieved successfully.

ProductPriceResponse application/json

401 - Unauthorized - The user could not be authenticated.

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

Request and Response Object Schemata

ProductPriceRequest application/json

{

"data":
object
A ProductPriceRequestData object.
{
- "customerId":
  string
  The customer for whom the prices are requested. If no customer is given, the value is an empty string. | Example: OilCorp
- "tenantId":
  string
  ID to identify the sender | Example: inTRONICS
- "priceType":
  string
  The price type used in the channel. The returned prices will be interpreted as prices of this price type. | Example: net
- "priceListType":
  string
  The requested price list type | Example: SalePrice
- "currency":
  string
  Three-letter currency code (ISO 4217) of the monetary value | Example: USD
- "products":
  array
  An array of string literals. A list of product IDs | Example: ["78412-452","84236-a32"]
}

}

ProductPriceResponse application/json

{

"data":
array
An array of ProductPriceContainer objects.
[
ProductPriceContainer: Price container for one product
{
- "productId":
  string
  Required | Identifier of a product | Example: 78412-452
- "prices":
  array
  Required | An array of ScaledPrice objects. A list of applicable prices for different quantities of the product
  [
  ScaledPrice: A price applicable for a specified minimum order quantity
  {
  "minQuantity":
  object
  A Quantity object. A quantity of a business entity
  {
  "unit":
  string
  The quantity's unit code | Example: kg
  "value":
  number
  Required | The quantity's value | Example: 10
  }
  "singleBasePrice":
  object
  A Money object. Describes a money object
  {
  "currency":
  string
  Required | Three-letter currency code (ISO 4217) of the monetary value | Example: USD
  "value":
  number
  Required | The monetary value | Example: 10.99
  }
  }
  ]
- "customAttributes":
  array
  An array of CustomAttribute objects.
  [
  CustomAttribute
  {
  "name":
  string
  Name of the custom attribute | Example: Tax
  "value":
  string
  Value of the custom attribute | Example: 19
  }
  ]
}
]
"messages":
array
An array of Message objects.
[
Message: A message to be logged
{
- "level":
  string
  Possible Values: INFOWARNERROR
- "code":
  string
  Example: product.not_found
- "description":
  string
  Example: product with id 84236-a32 not found
}
]

}

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.