1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Admin
  4. Inventory

updateInventory

put

/ccadmin/v1/inventories/{id}

Update inventory information based on ID.

Request

Supported Media Types
Path Parameters
Query Parameters
Body ()
Inventory update request object.
Root Schema : updateInventory_request
Type: object
Show Source
Nested Schema : inventoryInfo
Type: object
Inventory information
Show Source
Nested Schema : updatedItems
Type: array
Array of updated items
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : sku
Type: object
Properties of SKU from Product Catalog
Show Source
Nested Schema : parentProducts
Type: array
Properties of parent product of the SKU from Product Catalog
Show Source
Nested Schema : variants
Type: array
Array containing variant info of the SKU
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

When locationId is not passed in request body, inventory info will appear in a flat structure. When locationIds ss passed in request body, inventory info will appear within a 'locationInventoryInfo' JSON object in the response.
Body ()
Root Schema : updateInventory_response
Type: object
Show Source
Nested Schema : locationInventoryInfo
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
{
    "skuNumber":"Sku_15DE",
    "displayName":null,
    "links":[
        {
            "rel":"self",
            "href":"http://admin.example.com/ccadminui/v1/inventories/Sku_15DE"
        }
    ],
    "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":"Sku_15DE"
}
Example Response (description)
Example response when locationId is passed in request.

Default Response

The error response. The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud: Error Code / Description ------------------ ------------------ 25110 / Internal inventory error 25111 / Missing sku id 25112 / Invalid properties map 25115 / Inventory record not found 25116 / Location is invalid 25134 / Operation not supported for type 25135 / Invalid type
Body ()
Root Schema : errorModel
Type: object
Show Source
Nested Schema : errors
Type: array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top