Interface OutOfStockError

Returned when some of the Line Items are out of stock at the time of placing an Order.

The error is returned as a failed response to:

- [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders.
- [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders.
- [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) and [Create Order from Quote in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/quotes:POST) requests on Associate Orders.
interface OutOfStockError {
    code: "OutOfStock";
    lineItems: string[];
    message: string;
    skus: string[];
    [key: string]: any;
}

Hierarchy (View Summary)

Indexable

  • [key: string]: any

Properties

code lineItems message skus

Properties

Readonlycode

code: "OutOfStock"

Error identifier.

ReadonlylineItems

lineItems: string[]

Unique identifiers of the Line Items that are out of stock.

Readonlymessage

message: string

"Some line items are out of stock at the time of placing the order: $itemSku."

Readonlyskus

skus: string[]

SKUs of the Line Items that are out of stock.

Settings

Member Visibility

On This Page

Properties