1. REST API for Oracle Commerce Cloud December 2017
  2. Tasks
  3. Store
  4. Inventory

getInventory

get

/ccstore/v1/inventories/{id}

Get Inventory. Get inventory information for a variant or product. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
  • application/json
Path Parameters
id
Type: string
Required: true
The ID of the product or sku whose inventory detail information is to be retrieved. The ID given should correspond to the type given. So if the type is a product, a product ID has to be given here else a sku ID.
Query Parameters
catalogId
Type: string
ID of the catalog.
includeDefaultLocationInventory
Type: boolean
If set to true then inventory detail not associated with any particular location will be included alongside the location specific inventory details
locationIds
Type: string
A comma-separated list of location IDs for which inventory detail information is to be retrieved
type
Type: string
Type of data whose inventory information it to be retrieved. The options are "product" and "variant". Defaults to "variant".
Header Parameters
X-CCAsset-Language
Type: string
The asset language of the request

Response

Supported Media Types
  • application/json
200 Response
Following model is returned when operation succeeds.
Body
Root Schema : getInventory_response
Nested Schema : example with locationIds
Type: object
Result object with locationIds.
Nested Schema : example without locationIds
Type: object
Result object without locationIds.
Nested Schema : If the selected case was a product.
Type: object
Result object if type is product.
Nested Schema : If the selected case was a variant.
Type: object
Result object if type is variant.
Nested Schema : childSKUs
Type: array
List of SKU's for the product.
Nested Schema : items
Type: object
Nested Schema : locationInventoryInfo
Type: array
Location specific inventory information
Nested Schema : items
Type: object
Nested Schema : locationInventoryInfo
Type: array
Location specific inventory information
Nested Schema : items
Type: object
Nested Schema : If the selected case was a product.
Type: object
Result object if type is product.
Nested Schema : If the selected case was a variant.
Type: object
Result object if type is variant.
Nested Schema : childSKUs
Type: array
List of SKU's for the product.
Nested Schema : items
Type: object
Example application/json

{
    "preorderThreshold":0,
    "backorderLevel":0,
    "displayName":"Block Table",
    "availabilityDate":null,
    "stockThreshold":0,
    "availabilityStatusMsg":"inStock",
    "stockLevel":12,
    "availableToPromise":null,
    "skuNumber":"xsku2125_1",
    "preorderLevel":0,
    "locationId":null,
    "translations":null,
    "inventoryId":null,
    "backorderThreshold":0,
    "links":[
        {
            "rel":"self",
            "href":"http://localhost:8080/ccstore/v1/inventories/xsku2125_1?catalogId=null"
        }
    ],
    "availabilityStatus":1000,
    "skuId":"xsku2125_1"
}
Default Response
The error response
Body
Root Schema : errorModel
Type: object
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Nested Schema : items
Type: object

Examples

Sample Response Payload returned by endpoint:

{
  "preorderThreshold": 0,
  "backorderLevel": 0,
  "displayName": "Block Table",
  "availabilityDate": null,
  "stockThreshold": 0,
  "availabilityStatusMsg": "inStock",
  "stockLevel": 12,
  "availableToPromise": null,
  "skuNumber": "xsku2125_1",
  "preorderLevel": 0,
  "locationId": null,
  "translations": null,
  "inventoryId": null,
  "backorderThreshold": 0,
  "links": [{
    "rel": "self",
    "href": "http://localhost:8080/ccstore/v1/inventories/xsku2125_1?catalogId=null"
  }],
  "availabilityStatus": 1000,
  "skuId": "xsku2125_1"
}