Jump to

• Request
• Response

listStockStatusForLargeCart

post

/ccstore/v1/stockStatus

Gets the stock status of the list of products for large cart

Request

Supported Media Types

• application/json

Body ()

Root Schema : listStockStatusForLargeCart_request

Type: object

Show Source

• catalogId(optional): string
  catalog id of the products
• products(optional): string
  Product ids separated by comma. Supports the productId:skuId format to narrow down the results to a particular sku.

{
    "properties":{
        "catalogId":{
            "description":"catalog id of the products",
            "type":"string"
        },
        "products":{
            "description":"Product ids separated by comma.  Supports the productId:skuId format to narrow down the results to a particular sku.",
            "type":"string"
        }
    },
    "example":{
        "catalogId":"cloudLakeCatalog",
        "products":"camera_1:camerasku_1_5,Product_27Fxyzi"
    }
}

Example:

{
    "catalogId":"cloudLakeCatalog",
    "products":"camera_1:camerasku_1_5,Product_27Fxyzi"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listStockStatusForLargeCart_response

Type: object

Show Source

• items(optional): array items
  List of products along with stock statuses and orderable quantities

{
    "properties":{
        "items":{
            "description":"List of products along with stock statuses and orderable quantities",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "catalogId":{
                        "description":"Catalog id of the product",
                        "type":"string"
                    },
                    "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"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

List of products along with stock statuses and orderable quantities

Show Source

• Array of: object items

{
    "description":"List of products along with stock statuses and orderable quantities",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "catalogId":{
                "description":"Catalog id of the product",
                "type":"string"
            },
            "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"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "catalogId":{
            "description":"Catalog id of the product",
            "type":"string"
        },
        "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)

[
    {
        "catalogId":"cloudLakeCatalog",
        "productId":"camera_1",
        "preOrderableQuantity":0,
        "locationId":null,
        "orderableQuantity":5,
        "stockStatus":"IN_STOCK",
        "availabilityDate":null,
        "backOrderableQuantity":0,
        "catRefId":"camerasku_1_5",
        "inStockQuantity":5
    },
    {
        "Sku_27Gxyzi":"IN_STOCK",
        "productSkuInventoryStatus":{
            "Sku_27Gxyzi":3
        },
        "locationId":null,
        "stockStatus":"IN_STOCK",
        "productSkuInventoryDetails":[
            {
                "productId":"Product_27Fxyzii",
                "availabilityDate":null,
                "catRefId":"Sku_27Gxyzi"
            }
        ]
    }
]

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

• 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