Application Load

ICartDeliveryData

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

ICartDeliveryData

Selected delivery and its current change indicator.

app/interfaces/orionplace/cart/ICartData.ts
TypeScript
export interface ICartDeliveryData {
  // Confirmed delivery-type ID, or null when delivery must be selected. Match
  // it to `from_store.deliveries`; selecting a tariff locally does not confirm
  // it.
  method: number | null;
  // Delivery error text; an empty string means no error message is included.
  delivery_error: string;
  // Start of the estimated delivery-date range.
  delivery_date_from: IApiDateTime | null;
  // End of the estimated delivery-date range.
  delivery_date_to: IApiDateTime | null;
  // `true` signals a delivery change for this group. Check the returned
  // `method`, address and price; choose a method if `method` is `null`. The
  // notification clears after reading; `false` does not restore an earlier
  // selection.
  delivery_is_changed: boolean;
  // Selected delivery destination text.
  delivery_address: string;
  // Selected pickup-point code, when a method is selected.
  delivery_to_code?: string;
  // Carrier city code, when a method is selected.
  delivery_to_city_code?: string;
}