Application Load

IPhysicalStore

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

IPhysicalStore

Public physical-store information.

interfaces/orionplace/stores/IStoreDirectory.ts
TypeScript
export interface IPhysicalStore {
  // Physical-store ID.
  id: number;
  // Store name.
  store_name: string;
  // Translated city names in `store_city`, keyed by locale.
  locale: Record<string, {
    // Optional value of store_city; it may be omitted.
    store_city?: string;
  }>;
  // First address line.
  line1: string;
  // Second address line.
  line2: string;
  // Postal code.
  postcode: string;
  // Store coordinates: `longitude` and `latitude`.
  location: IPhysicalStoreLocation;
  // House identifier as text.
  house_number: string;
  // Entrance as text.
  entrance: string;
  // Intercom information.
  intercom: string;
  // Floor as text.
  floor: string;
  // Apartment or office identifier.
  apt_number: string;
  // Store phone number.
  phone_number: string;
  // `false` for the physical stores selected by this endpoint.
  virtual_goods: false;
  // Country object with ID, ISO codes, translated names and shipping flag;
  // nullable.
  country: IAddressCountry | null;
  // Region object with ID, translated names, country code and country ID;
  // nullable.
  state: IAddressRegion | null;
  /** Working weekdays only; days off are omitted. */
  working_hours: Record<string, IStoreOpeningHours> | null;
}