Jump to

• Request
• Response

Retrieve stock status by ID

get

/ccstore/v1/stockStatus/{id}

Retrieves the stock status of a product.

It is recommended that you set the optional query parameter actualStockStatus to true. It is false by default to avoid backwards compatibility issues with older clients using this endpoint. It allows more accurate stock status information to be returned should errors occurred accessing inventory levels.

If multiple inventories are present you can optionally pass in the inventory location you wish to filter by. In order to do this pass in the ID of the location in the locationId header.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID of the product to get the stock status

Query Parameters

• actualStockStatus(optional): string
  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.
• catalogId(optional): string
  Catalog ID of the product
• locationId(optional): string
  When multiple inventories are defined specify the individual inventory location to use. If you wish to explicitly query the default inventory (no location id set) then use the 'NULL' id. If locationId is 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).
• skuId(optional): string
  ID of the SKU of the product

Header Parameters

• X-CCAsset-Language(optional): string
  The asset language of the request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : getStockStatus_response

Type: object

Show Source

• availabilityDate(optional): string
  Availability date of the product
• backOrderableQuantity(optional): integer
  Quantity that can be backordered
• 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

{
    "properties":{
        "productId":{
            "description":"ID of the product",
            "type":"string"
        },
        "preOrderableQuantity":{
            "description":"Quantity that can be preordered",
            "type":"integer"
        },
        "orderableQuantity":{
            "description":"Maximum quantity that can be ordered",
            "type":"integer"
        },
        "locationId":{
            "description":"Inventory location id of the product",
            "type":"string"
        },
        "stockStatus":{
            "description":"Stock status of the product",
            "type":"string"
        },
        "availabilityDate":{
            "description":"Availability date of the product",
            "type":"string"
        },
        "backOrderableQuantity":{
            "description":"Quantity that can be backordered",
            "type":"integer"
        },
        "catRefId":{
            "description":"Sku reference id",
            "type":"string"
        },
        "inStockQuantity":{
            "description":"Quantity that is in stock",
            "type":"integer"
        }
    }
}

Example Response (application/json)

{
    "productId":"xprod2138",
    "preOrderableQuantity":0,
    "orderableQuantity":12,
    "locationId":"CRSHome-GlenAllen186",
    "stockStatus":"IN_STOCK",
    "availabilityDate":null,
    "backOrderableQuantity":0,
    "catRefId":"xsku2138",
    "inStockQuantity":12
}

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

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top