getInventory
get
/ccadmin/v1/inventories/{id}
Get variant or product inventory information based on ID. Optionally takes the X-CCAsset-Language header to get translated content in another language.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
id of the variant or product
Query Parameters
-
catalogId: string
id of catalog
-
includeDefaultLocationInventory: boolean
flag indicating whether to include the non-geographic default location inventory
-
locationIds: string
a comma-separated list of location ids
-
showTranslations: string
show translations, boolean true or false; default false
-
type: string
inventory type, either variant or product, defaults to variant
Header Parameters
-
X-CCAsset-Language: string
asset language of the request
Response
Supported Media Types
- application/json
200 Response
Success response.
Root Schema : getInventory_response
Type:
Show Source
object-
availabilityDate:
string
Availability date of SKU. Date format is an ISO standard such as yyyy-MM-dd.
-
availabilityStatus:
integer
Availability status of SKU.
-
availabilityStatusMsg:
string
Availability status message of SKU.
-
availableToPromise:
string
Tells whether product is available to promise.
-
backorderLevel:
integer
Backorder level of SKU.
-
backorderThreshold:
integer
Backorder threshold of SKU.
-
displayName:
string
Display name of SKU.
-
inventoryId:
string
Inventory ID of SKU.
-
locationId:
string
Location ID of SKU.
-
locationInventoryInfo:
array locationInventoryInfo
-
preorderLevel:
integer
Preorder level of SKU.
-
preorderThreshold:
integer
Preorder threshold of SKU.
-
skuId:
string
SKU ID.
-
skuNumber:
string
SKU number.
-
stockLevel:
integer
Stock level of SKU.
-
stockThreshold:
integer
Stock threshold of SKU.
-
translations:
object translations
Product translated properties.
Nested Schema : translations
Type:
objectProduct translated properties.
Nested Schema : items
Type:
Show Source
object-
availabilityDate:
string
Availability date of variant. Date format is an ISO standard such as yyyy-MM-dd.
-
availabilityStatus:
integer
Availability status/ available count of the variant.
-
availabilityStatusMsg:
string
Availability status message of the variant.
-
availableToPromise:
string
Available to promise.
-
backorderLevel:
integer
Backorder level of the variant.
-
backorderThreshold:
integer
Backorder threshold of the variant.
-
displayName:
string
Display name of the variant.
-
inventoryId:
string
Inventory id of the variant.
-
locationId:
string
Location id.
-
preorderLevel:
integer
Preorder level of the variant.
-
preorderThreshold:
integer
Preorder threshold of the variant.
-
skuNumber:
string
SKU number of the variant.
-
stockLevel:
integer
Stock level of the variant.
-
stockThreshold:
integer
Stock threshold of the variant.
Example Response (application/json)
{
"skuNumber":"sku40015",
"displayName":"Cargo Pants",
"links":[
{
"rel":"self",
"href":"http://www.example.com/v1/inventories/sku40015?locationId=wa-seattle"
}
],
"locationInventoryInfo":[
{
"preorderThreshold":0,
"backorderLevel":0,
"displayName":null,
"availabilityDate":null,
"availabilityStatusMsg":"inStock",
"stockThreshold":10,
"stockLevel":120,
"availableToPromise":null,
"skuNumber":null,
"preorderLevel":0,
"locationId":"loc1",
"translations":null,
"inventoryId":null,
"backorderThreshold":0,
"availabilityStatus":1000
}
],
"skuId":"sku40015"
}Example Response (description)
Example response when locationIds parameter is passed in requestDefault Response
The error response
Root Schema : errorModel
Type:
Show Source
object-
devMessage:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
errors:
array errors
An optional list of errors if multiple errors were encountered
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code
-
type:
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:
string
An optional non-localized message containing technical information for developers
-
errorCode:
string
The numerical code identifying the error
-
message:
string
The localized message describing the error
-
moreInfo:
string
An optional non-localized message with more information
-
o:errorPath:
string
An optional machine readable description of where the error occurred
-
status:
string
The HTTP status code