listInventories
get
/ccstore/v1/inventories
List Inventories. List inventories information for the comma seperated variants or products. Optionally takes the x-ccasset-language header to get translated content in another language.
Request
Supported Media Types
- application/json
Query Parameters
-
catalogId(optional): string
ID of the catalog.
-
ids: string
The comma seperated IDs of the product or sku whose inventory detail information is to be retrieved. The IDs given should correspond to the type given. So if the type is a product, product IDs has to be given here else sku IDs.
-
includeDefaultLocationInventory(optional): boolean
If set to true then inventory detail not associated with any particular location will be included alongside the location specific inventory details
-
locationIds(optional): string
A comma-separated list of location IDs for which inventory detail information is to be retrieved
-
type(optional): 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(optional): string
The asset language of the request
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listInventories_response
Type:
Show Source
object-
items(optional):
array items
-
limit(optional):
integer
Limit of number of products.
-
offset(optional):
integer
Offset of product inventory.
-
sort(optional):
array sort
-
totalResults(optional):
integer
Total number of products.
Nested Schema : items
Type:
Show Source
object-
childSKUs(optional):
array childSKUs
-
displayName(optional):
string
Display name of the product.
-
id(optional):
string
ID name of the product.
-
productNumber(optional):
string
Product number of the product. Product only.
-
stockStatus(optional):
string
Stock status of the product.
-
totalStockLevel(optional):
integer
Total stock level of the product.
-
translations(optional):
object translations
Product translated properties.
Nested Schema : translations
Type:
objectProduct translated properties.
Nested Schema : items
Type:
Show Source
object-
availabilityDate(optional):
string
Availability date of SKU. Date format is an ISO standard such as yyyy-MM-dd.
-
availabilityStatus(optional):
integer
Availability status of SKU.
-
availabilityStatusMsg(optional):
string
Availability status message of SKU.
-
availableToPromise(optional):
string
Available to promise of SKU.
-
backorderLevel(optional):
integer
Backorder level of SKU.
-
backorderThreshold(optional):
integer
Backorder threshold of SKU.
-
displayName(optional):
string
Display name of SKU.
-
inventoryId(optional):
string
Inventory ID of SKU.
-
locationId(optional):
string
Location ID of SKU.
-
locationInventoryInfo(optional):
array locationInventoryInfo
-
preorderLevel(optional):
integer
Preorder level of SKU.
-
preorderThreshold(optional):
integer
Preorder threshold of SKU.
-
skuId(optional):
string
SKU ID of SKU.
-
skuNumber(optional):
string
SKU number of SKU.
-
stockLevel(optional):
integer
Stock level of SKU.
-
stockThreshold(optional):
integer
Stock threshold of SKU.
Nested Schema : items
Type:
Show Source
object-
availabilityDate(optional):
string
Availability date of variant. Date format is an ISO standard such as yyyy-MM-dd.
-
availabilityStatus(optional):
integer
Availability status/ available count of the variant.
-
availabilityStatusMsg(optional):
string
Availability status message of the variant.
-
availableToPromise(optional):
string
Available to promise.
-
backorderLevel(optional):
integer
Backorder level of the variant.
-
backorderThreshold(optional):
integer
Backorder threshold of the variant.
-
displayName(optional):
string
Display name of the variant.
-
inventoryId(optional):
string
Inventory id of the variant.
-
locationId(optional):
string
Location id.
-
preorderLevel(optional):
integer
Preorder level of the variant.
-
preorderThreshold(optional):
integer
Preorder threshold of the variant.
-
skuNumber(optional):
string
SKU number of the variant.
-
stockLevel(optional):
integer
Stock level of the variant.
-
stockThreshold(optional):
integer
Stock threshold of the variant.
Nested Schema : items
Type:
Show Source
object-
order(optional):
string
Direction of sort.
-
property(optional):
string
Name of property sorted by.
Example Response (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,
"availabilityStatus":1000,
"skuId":"xsku2125_1"
},
{
"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,
"availabilityStatus":1000,
"skuId":"sku_123"
}
]Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code