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
This section covers retrieving inventory data for products.
/inventories
GET: Returns inventory for one or more products
Description
This operation returns inventory information for one or more products based on the SKU(s) provided as parameter.
Java Method
public javax.ws.rs.core.Response com.intershop.sellside.rest.inventory.v1.capi.resource.InventoryResource.getInventories(java.util.List)
Request Body
--
Request Parameters
Location | Name | Format | Default | Example | Description |
---|
in query | sku | array | | 4810740 | Required | The product SKU(s) (one or multiple values: sku=...&sku=...) |
Response
200 - OK - The inventory was successfully retrieved.
InventoryROListCtnrRO_v1 application/vnd.intershop.inventory.v1+json
InventoryROListCtnrRO_v1 application/vnd.intershop.inventory.v1+json
{"data":
array
An array of InventoryRO
objects. The core data of the response object.
[
InventoryRO
:
Inventory container for one product that holds inventory.{
}
]
"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
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"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
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"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.
}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.