Jump to

• Request
• Response

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: string
  id of the variant or product

Query Parameters

• catalogId(optional): string
  id of catalog
• includeDefaultLocationInventory(optional): boolean
  flag indicating whether to include the non-geographic default location inventory
• locationIds(optional): string
  a comma-separated list of location ids
• showTranslations(optional): string
  show translations, boolean true or false; default false
• type(optional): string
  inventory type, either variant or product, defaults to variant

Header Parameters

• X-CCAsset-Language(optional): string
  asset language of the request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success response.

Body ()

Root Schema : getInventory_response

Type: object

Show Source

• 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
  Tells whether product is available to promise.
• 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.
• skuNumber(optional): string
  SKU number.
• stockLevel(optional): integer
  Stock level of SKU.
• stockThreshold(optional): integer
  Stock threshold of SKU.
• translations(optional): object translations
  Product translated properties.

{
    "properties":{
        "preorderThreshold":{
            "description":"Preorder threshold of SKU.",
            "type":"integer"
        },
        "backorderLevel":{
            "description":"Backorder level of SKU.",
            "type":"integer"
        },
        "displayName":{
            "description":"Display name of SKU.",
            "type":"string"
        },
        "availabilityDate":{
            "description":"Availability date of SKU. Date format is an ISO standard such as yyyy-MM-dd.",
            "type":"string"
        },
        "stockThreshold":{
            "description":"Stock threshold of SKU.",
            "type":"integer"
        },
        "availabilityStatusMsg":{
            "description":"Availability status message of SKU.",
            "type":"string"
        },
        "stockLevel":{
            "description":"Stock level of SKU.",
            "type":"integer"
        },
        "availableToPromise":{
            "description":"Tells whether product is available to promise.",
            "type":"string"
        },
        "skuNumber":{
            "description":"SKU number.",
            "type":"string"
        },
        "preorderLevel":{
            "description":"Preorder level of SKU.",
            "type":"integer"
        },
        "locationId":{
            "description":"Location ID of SKU.",
            "type":"string"
        },
        "translations":{
            "description":"Product translated properties.",
            "type":"object"
        },
        "inventoryId":{
            "description":"Inventory ID of SKU.",
            "type":"string"
        },
        "backorderThreshold":{
            "description":"Backorder threshold of SKU.",
            "type":"integer"
        },
        "availabilityStatus":{
            "description":"Availability status of SKU.",
            "type":"integer"
        },
        "locationInventoryInfo":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "preorderThreshold":{
                        "description":"Preorder threshold of the variant.",
                        "type":"integer"
                    },
                    "backorderLevel":{
                        "description":"Backorder level of the variant.",
                        "type":"integer"
                    },
                    "displayName":{
                        "description":"Display name of the variant.",
                        "type":"string"
                    },
                    "availabilityDate":{
                        "description":"Availability date of variant. Date format is an ISO standard such as yyyy-MM-dd.",
                        "type":"string"
                    },
                    "availabilityStatusMsg":{
                        "description":"Availability status message of the variant.",
                        "type":"string"
                    },
                    "stockThreshold":{
                        "description":"Stock threshold of the variant.",
                        "type":"integer"
                    },
                    "stockLevel":{
                        "description":"Stock level of the variant.",
                        "type":"integer"
                    },
                    "availableToPromise":{
                        "description":"Available to promise.",
                        "type":"string"
                    },
                    "skuNumber":{
                        "description":"SKU number of the variant.",
                        "type":"string"
                    },
                    "preorderLevel":{
                        "description":"Preorder level of the variant.",
                        "type":"integer"
                    },
                    "locationId":{
                        "description":"Location id.",
                        "type":"string"
                    },
                    "inventoryId":{
                        "description":"Inventory id of the variant.",
                        "type":"string"
                    },
                    "backorderThreshold":{
                        "description":"Backorder threshold of the variant.",
                        "type":"integer"
                    },
                    "availabilityStatus":{
                        "description":"Availability status/ available count of the variant.",
                        "type":"integer"
                    }
                }
            }
        },
        "skuId":{
            "description":"SKU ID.",
            "type":"string"
        }
    }
}

Nested Schema : locationInventoryInfo

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "preorderThreshold":{
                "description":"Preorder threshold of the variant.",
                "type":"integer"
            },
            "backorderLevel":{
                "description":"Backorder level of the variant.",
                "type":"integer"
            },
            "displayName":{
                "description":"Display name of the variant.",
                "type":"string"
            },
            "availabilityDate":{
                "description":"Availability date of variant. Date format is an ISO standard such as yyyy-MM-dd.",
                "type":"string"
            },
            "availabilityStatusMsg":{
                "description":"Availability status message of the variant.",
                "type":"string"
            },
            "stockThreshold":{
                "description":"Stock threshold of the variant.",
                "type":"integer"
            },
            "stockLevel":{
                "description":"Stock level of the variant.",
                "type":"integer"
            },
            "availableToPromise":{
                "description":"Available to promise.",
                "type":"string"
            },
            "skuNumber":{
                "description":"SKU number of the variant.",
                "type":"string"
            },
            "preorderLevel":{
                "description":"Preorder level of the variant.",
                "type":"integer"
            },
            "locationId":{
                "description":"Location id.",
                "type":"string"
            },
            "inventoryId":{
                "description":"Inventory id of the variant.",
                "type":"string"
            },
            "backorderThreshold":{
                "description":"Backorder threshold of the variant.",
                "type":"integer"
            },
            "availabilityStatus":{
                "description":"Availability status/ available count of the variant.",
                "type":"integer"
            }
        }
    }
}

Nested Schema : translations

Type: object

Product translated properties.

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "preorderThreshold":{
            "description":"Preorder threshold of the variant.",
            "type":"integer"
        },
        "backorderLevel":{
            "description":"Backorder level of the variant.",
            "type":"integer"
        },
        "displayName":{
            "description":"Display name of the variant.",
            "type":"string"
        },
        "availabilityDate":{
            "description":"Availability date of variant. Date format is an ISO standard such as yyyy-MM-dd.",
            "type":"string"
        },
        "availabilityStatusMsg":{
            "description":"Availability status message of the variant.",
            "type":"string"
        },
        "stockThreshold":{
            "description":"Stock threshold of the variant.",
            "type":"integer"
        },
        "stockLevel":{
            "description":"Stock level of the variant.",
            "type":"integer"
        },
        "availableToPromise":{
            "description":"Available to promise.",
            "type":"string"
        },
        "skuNumber":{
            "description":"SKU number of the variant.",
            "type":"string"
        },
        "preorderLevel":{
            "description":"Preorder level of the variant.",
            "type":"integer"
        },
        "locationId":{
            "description":"Location id.",
            "type":"string"
        },
        "inventoryId":{
            "description":"Inventory id of the variant.",
            "type":"string"
        },
        "backorderThreshold":{
            "description":"Backorder threshold of the variant.",
            "type":"integer"
        },
        "availabilityStatus":{
            "description":"Availability status/ available count of the variant.",
            "type":"integer"
        }
    }
}

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 request

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top