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

getStockStatuses

get

/ccagent/v1/stockStatus

Get Stock Statuses. Gets the stock statuses and orderable quantity details of all the items in the cart. If multiple inventories are defined optionally pass in the inventory locations you wish to view. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types
Query Parameters
  • When this parameter is true, the actual stock status of the product / sku will be returned to the client. By default, we show all products / skus as in stock when the stock level is 0.
  • Catalog Ids of the products
  • Select the products stock status that you wish to exclude from the returned results - for example excludeStatus=OUT_OF_STOCK.
  • Flag to include all the stock details for each sku when skuId is not sent as part of query
  • Inventory location ids separated by comma. When multiple inventories exist specify which inventory location(s) to query. If you wish to explicitly query the default inventory (no location id set) then use the 'NULL' id. 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.
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Following model is returned when operation succeeds.
Body ()
Root Schema : getStockStatuses_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":"prod10011",
        "preOrderableQuantity":0,
        "orderableQuantity":95,
        "stockStatus":"IN_STOCK",
        "availabilityDate":null,
        "backOrderableQuantity":50,
        "catRefId":"sku10024",
        "inStockQuantity":25
    },
    {
        "catalogId":"cloudLakeCatalog",
        "productId":"Product_9E",
        "preOrderableQuantity":50,
        "orderableQuantity":95,
        "locationId":"CRSHome-GlenAllen186",
        "stockStatus":"IN_STOCK",
        "availabilityDate":null,
        "backOrderableQuantity":0,
        "catRefId":"Sku_9F",
        "inStockQuantity":25
    },
    {
        "catalogId":"cloudLakeCatalog",
        "productId":"Product_9E",
        "preOrderableQuantity":50,
        "orderableQuantity":95,
        "locationId":"CRSHome-GlenAllen187",
        "stockStatus":"IN_STOCK",
        "availabilityDate":null,
        "backOrderableQuantity":0,
        "catRefId":"Sku_9F",
        "inStockQuantity":25
    },
    {
        "catalogId":"null",
        "productId":"Product_9E",
        "locationId":"CRSHome-GlenAllen186",
        "stockStatus":"OUT_OF_STOCK",
        "catRefId":"Sku_9F"
    }
]

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| |------------------|------------------| |20030|If some internal error|
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