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-
example with locationIds(optional):
object example with locationIds
Result object with locationIds.
-
example without locationIds(optional):
object example without locationIds
Result object without locationIds.
Nested Schema : example with locationIds
Type:
objectResult object with locationIds.
Show Source
-
If the selected case was a product.(optional):
object If the selected case was a product.
Result object if type is product.
-
If the selected case was a variant.(optional):
object If the selected case was a variant.
Result object if type is variant.
Nested Schema : example without locationIds
Type:
objectResult object without locationIds.
Show Source
-
If the selected case was a product.(optional):
object If the selected case was a product.
Result object if type is product.
-
If the selected case was a variant.(optional):
object If the selected case was a variant.
Result object if type is variant.
Nested Schema : If the selected case was a product.
Type:
objectResult object if type is product.
Show Source
-
childSKUs(optional):
array childSKUs
List of SKU's for the product.
-
id(optional):
string
The ID of the product.
-
stockStatus(optional):
string
The current stock status of the product (inStock or outOfStock).
-
totalStockLevel(optional):
integer
The total stock level of the product.
Nested Schema : If the selected case was a variant.
Type:
objectResult object if type is variant.
Show Source
-
displayName(optional):
string
The display name of the SKU.
-
locationInventoryInfo(optional):
array locationInventoryInfo
Location specific inventory information
-
skuId(optional):
string
The SKU ID of the SKU.
-
skuNumber(optional):
string
The SKU number of the SKU.
Nested Schema : items
Type:
Show Source
object-
displayName(optional):
string
The display name of the SKU.
-
locationInventoryInfo(optional):
array locationInventoryInfo
Location specific inventory information
-
skuId(optional):
string
The SKU ID of the SKU.
-
skuNumber(optional):
string
The SKU number of the SKU.
Nested Schema : locationInventoryInfo
Type:
arrayLocation specific inventory information
Show Source
Nested Schema : items
Type:
Show Source
object-
availabilityDate(optional):
string
The date when the SKU will be available.
-
availabilityStatus(optional):
integer
The availability status of the child SKU.
-
availabilityStatusMsg(optional):
string
The current availability status of the child SKU.
-
availableToPromise(optional):
string
The available to promise of the child SKU.
-
backorderLevel(optional):
integer
The back-order level of the child SKU.
-
backorderThreshold(optional):
integer
The back-order threshold of the child SKU.
-
inventoryId(optional):
string
The inventory ID of the SKU.
-
locationId(optional):
string
The location ID of the child SKU.
-
preorderLevel(optional):
integer
The pre-order level of the child SKU.
-
preorderThreshold(optional):
integer
The pre-order threshold of the child SKU.
-
stockLevel(optional):
integer
The stock level of the SKU.
-
stockThreshold(optional):
integer
The stock threshold of the child SKU.
Nested Schema : locationInventoryInfo
Type:
arrayLocation specific inventory information
Show Source
Nested Schema : items
Type:
Show Source
object-
availabilityDate(optional):
string
The date when the SKU will be available.
-
availabilityStatus(optional):
integer
The availability status of the child SKU.
-
availabilityStatusMsg(optional):
string
The current availability status of the child SKU.
-
availableToPromise(optional):
string
The available to promise of the child SKU.
-
backorderLevel(optional):
integer
The back-order level of the child SKU.
-
backorderThreshold(optional):
integer
The back-order threshold of the child SKU.
-
inventoryId(optional):
string
The inventory ID of the SKU.
-
locationId(optional):
string
The location ID of the child SKU.
-
preorderLevel(optional):
integer
The pre-order level of the child SKU.
-
preorderThreshold(optional):
integer
The pre-order threshold of the child SKU.
-
stockLevel(optional):
integer
The stock level of the SKU.
-
stockThreshold(optional):
integer
The stock threshold of the child SKU.
Nested Schema : If the selected case was a product.
Type:
objectResult object if type is product.
Show Source
-
childSKUs(optional):
array childSKUs
List of SKU's for the product.
-
id(optional):
string
The ID of the product.
-
stockStatus(optional):
string
The current stock status of the product (inStock or outOfStock).
-
totalStockLevel(optional):
integer
The total stock level of the product.
Nested Schema : If the selected case was a variant.
Type:
objectResult object if type is variant.
Show Source
-
availabilityDate(optional):
string
The date when the SKU will be available.
-
availabilityStatus(optional):
integer
The availability status of the child SKU.
-
availabilityStatusMsg(optional):
string
The current availability status of the child SKU.
-
availableToPromise(optional):
string
The available to promise of the child SKU.
-
backorderLevel(optional):
integer
The back-order level of the child SKU.
-
backorderThreshold(optional):
integer
The back-order threshold of the child SKU.
-
displayName(optional):
string
The display name of the SKU.
-
inventoryId(optional):
string
The inventory ID of the SKU.
-
locationId(optional):
string
The location ID of the child SKU.
-
preorderLevel(optional):
integer
The pre-order level of the child SKU.
-
preorderThreshold(optional):
integer
The pre-order threshold of the child SKU.
-
skuId(optional):
string
The SKU ID of the SKU.
-
skuNumber(optional):
string
The SKU number of the SKU.
-
stockLevel(optional):
integer
The stock level of the SKU.
-
stockThreshold(optional):
integer
The stock threshold of the child SKU.
Nested Schema : items
Type:
Show Source
object-
availabilityDate(optional):
string
The date when the SKU will be available.
-
availabilityStatus(optional):
integer
The availability status of the child SKU.
-
availabilityStatusMsg(optional):
string
The current availability status of the child SKU.
-
availableToPromise(optional):
string
The available to promise of the child SKU.
-
backorderLevel(optional):
integer
The back-order level of the child SKU.
-
backorderThreshold(optional):
integer
The back-order threshold of the child SKU.
-
displayName(optional):
string
The display name of the SKU.
-
inventoryId(optional):
string
The inventory ID of the SKU.
-
locationId(optional):
string
The location ID of the child SKU.
-
preorderLevel(optional):
integer
The pre-order level of the child SKU.
-
preorderThreshold(optional):
integer
The pre-order threshold of the child SKU.
-
skuId(optional):
string
The SKU ID of the SKU.
-
skuNumber(optional):
string
The SKU number of the SKU.
-
stockLevel(optional):
integer
The stock level of the SKU.
-
stockThreshold(optional):
integer
The stock threshold of the child SKU.
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