Application Load

IDeliveryType

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

IDeliveryType

Public delivery tariff.

interfaces/orionplace/cart/ICartData.ts
TypeScript
export interface IDeliveryType {
  // Delivery-type ID.
  id: number;
  // Translated tariff name and external description.
  locales: Record<
    string,
    {
      // Optional value of tariff_name; it may be omitted.
      tariff_name?: string;
      // Optional value of tariff_desc_external; it may be omitted.
      tariff_desc_external?: string;
    }
  >;
  // Delivery to a pickup point.
  delivery_to_carrier_point: boolean;
  // Carrier ID, translated names and logo.
  carrier: {
    // Delivery-type ID.
    id: number;
    // Value of locale.
    locale: Record<string, {
      // Optional value of carrier_name; it may be omitted.
      carrier_name?: string;
    }>;
    // Value of carrier_logo.
    carrier_logo: string | null;
  } | null;
  // Carrier weight limit in kilograms.
  max_weight_kg: number;
  // Applicable package dimensions and limits, when present.
  box: ICarrierBox | null;
}