1. REST API for Oracle Commerce Cloud 22A
  2. Tasks
  3. Store
  4. Stock Status

List stock status for large cart

post

/ccstore/v1/stockStatus

Retrieves the stock statuses and orderable quantity details of all the items specified.

When there are too many items to be specified as query parameters use this endpoint. Within the request body for this endpoint you specify an "application/json" object containing two properties referred to as products and catalogId.

products are the Ids of the items for which stock statuses will be retrieved.
catalogId refers to the Id of the catalog where these products reside.
locationIds are the Ids of the locations for which stock statuses will be retrieved.

Note: Multiple product ids are separated by comma. It also supports the productId:skuId format to narrow down the results to a particular sku.

Information returned by this endpoint includes a product's current stock status, the product's quantity as well as the availability date of the product.

See Improve Storefront Performance for Large Carts for more information on handling large carts.

This endpoint optionally takes the x-ccasset-language header in order to retrieve translated content in another language.

Request

Supported Media Types
Body ()
Root Schema : listStockStatusForLargeCart_request
Type: object
Show Source
  • catalog id of the products
  • Inventory location ids separated by comma. When multiple inventories exist specify which inventory location(s) to query. If you wish to query the default inventory location along with other locations, then include 'NULL' alongside the other IDs. If locationIds are not specified then the query will default to use the site???s inventory location id if set, otherwise the query will use the default inventory (no location id set).
  • Product ids separated by comma. Supports the productId:skuId format to narrow down the results to a particular sku.
Example:
{
    "catalogId":"cloudLakeCatalog",
    "locationIds":"Warehouse1,Warehouse2",
    "products":"camera_1:camerasku_1_5,Product_27Fxyzi"
}
Back to Top

Response

Supported Media Types

200 Response

Returned when the operation succeeds.
Body ()
Root Schema : listStockStatusForLargeCart_response
Type: object
Show Source
Nested Schema : items
Type: array
List of products along with stock statuses and orderable quantities
Show Source
Nested Schema : items
Type: object
Show Source
Example Response (application/json)
[
    {
        "catalogId":"cloudLakeCatalog",
        "productId":"camera_1",
        "preOrderableQuantity":0,
        "locationId":"Warehouse1",
        "orderableQuantity":5,
        "stockStatus":"IN_STOCK",
        "availabilityDate":null,
        "backOrderableQuantity":0,
        "catRefId":"camerasku_1_5",
        "inStockQuantity":5
    },
    {
        "catalogId":"cloudLakeCatalog",
        "productId":"camera_1",
        "preOrderableQuantity":0,
        "locationId":"Warehouse2",
        "orderableQuantity":5,
        "stockStatus":"IN_STOCK",
        "availabilityDate":null,
        "backOrderableQuantity":0,
        "catRefId":"camerasku_1_5",
        "inStockQuantity":5
    },
    {
        "Sku_27Gxyzi":"IN_STOCK",
        "productSkuInventoryStatus":{
            "Sku_27Gxyzi":5
        },
        "locationId":"Warehouse1",
        "stockStatus":"IN_STOCK",
        "productSkuInventoryDetails":[
            {
                "productId":"Product_27Fxyzii",
                "availabilityDate":null,
                "catRefId":"Sku_27Gxyzi"
            }
        ]
    },
    {
        "Sku_27Gxyzi":"IN_STOCK",
        "productSkuInventoryStatus":{
            "Sku_27Gxyzi":3
        },
        "locationId":"Warehouse2",
        "stockStatus":"IN_STOCK",
        "productSkuInventoryDetails":[
            {
                "productId":"Product_27Fxyzii",
                "availabilityDate":null,
                "catRefId":"Sku_27Gxyzi"
            }
        ]
    }
]

Default Response

The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
Error CodeDescription
20030General error accessing product information
25100General error accessing inventory information
200104Catalog not accessible by current profile
200105Catalog does not exist
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