Application Load

ICartGetResponse

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

ICartGetResponse

Full cart with checkout-dependent content.

interfaces/orionplace/cart/ICartData.ts
TypeScript
export interface ICartGetResponse {
  // Field or general errors.
  form_errors: Record<string, ApiFormError[]> | null;
  // Success message, or null.
  success_message: string | null;
  // Summary, state-dependent content and products that cannot ship.
  page_data: {
    // Value of cart.
    cart: ICartSummary;
    // In `ECartState.STATE_CART`, an array of products with detailed cart
    // counts. In `ECartState.STATE_CHECKOUT`, an array of delivery groups, each
    // containing `product_items`.
    cart_data: IProduct[] | ICartDelivery[];
    // Products whose unshippable quantity is at least their requested quantity.
    // Partially unshippable products are not included here.
    will_not_ship: IProduct[];
  } | null;
}