REST API for Oracle Commerce Cloud December 2017

getStockStatuses

get

/ccstore/v1/stockStatus

Get Stock Statuses. Gets the stock statuses and orderable quantity details of all the items in the cart. Optionally takes the x-ccasset-language header to get translated content in another language.

Request

Supported Media Types

application/json

Query Parameters

catalogId: Type: string

Catalog Ids of the products
products: Type: string

Product ids separated by comma

Header Parameters

X-CCAsset-Language: Type: string

The asset language of the request

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : getStockStatuses_response

Properties

items: Type: array items

Additional Properties Allowed:

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

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

availabilityDate: Type: string

Availability date of the product
backOrderableQuantity: Type: integer

Quantity that can be backordered
catalogId: Type: string

Catalog id of the product
catRefId: Type: string

Sku reference id
inStockQuantity: Type: integer

Quantity that is in stock
orderableQuantity: Type: integer

Maximum quantity that can be ordered
preOrderableQuantity: Type: integer

Quantity that can be preordered
productId: Type: string

Id of the product
stockStatus: Type: string

Stock status of the product

Example application/json


[
    {
        "catalogId":null,
        "productId":"prod10011",
        "preOrderableQuantity":0,
        "orderableQuantity":95,
        "stockStatus":"IN_STOCK",
        "availabilityDate":null,
        "backOrderableQuantity":50,
        "catRefId":"sku10024",
        "inStockQuantity":25
    },
    {
        "catalogId":null,
        "productId":"Product_9E",
        "preOrderableQuantity":50,
        "orderableQuantity":95,
        "stockStatus":"IN_STOCK",
        "availabilityDate":null,
        "backOrderableQuantity":0,
        "catRefId":"Sku_9F",
        "inStockQuantity":25
    }
]

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

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Response Payload returned by endpoint:

[
  {
    "catalogId": null,
    "productId": "prod10011",
    "preOrderableQuantity": 0,
    "orderableQuantity": 95,
    "stockStatus": "IN_STOCK",
    "availabilityDate": null,
    "backOrderableQuantity": 50,
    "catRefId": "sku10024",
    "inStockQuantity": 25
  },
  {
    "catalogId": null,
    "productId": "Product_9E",
    "preOrderableQuantity": 50,
    "orderableQuantity": 95,
    "stockStatus": "IN_STOCK",
    "availabilityDate": null,
    "backOrderableQuantity": 0,
    "catRefId": "Sku_9F",
    "inStockQuantity": 25
  }
]