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.
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
- application/json
Root Schema : listStockStatusForLargeCart_request
Type:
Show Source
object
-
catalogId(optional):
string
catalog id of the products
-
locationIds(optional):
string
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).
-
products(optional):
string
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"
}
Response
Supported Media Types
- application/json
200 Response
Returned when the operation succeeds.
Root Schema : listStockStatusForLargeCart_response
Type:
Show Source
object
-
items(optional):
array items
List of products along with stock statuses and orderable quantities
Nested Schema : items
Type:
array
List of products along with stock statuses and orderable quantities
Show Source
Nested Schema : items
Type:
Show Source
object
-
availabilityDate(optional):
string
Availability date of the product
-
backOrderableQuantity(optional):
integer
Quantity that can be backordered
-
catalogId(optional):
string
Catalog id of the product
-
catRefId(optional):
string
Sku reference id
-
inStockQuantity(optional):
integer
Quantity that is in stock
-
locationId(optional):
string
Inventory location id of the product
-
orderableQuantity(optional):
integer
Maximum quantity that can be ordered
-
preOrderableQuantity(optional):
integer
Quantity that can be preordered
-
productId(optional):
string
ID of the product
-
stockStatus(optional):
string
Stock status of the product
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 Code | Description |
---|---|
20030 | General error accessing product information |
25100 | General error accessing inventory information |
200104 | Catalog not accessible by current profile |
200105 | Catalog does not exist |
Root Schema : errorModel
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
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