`IProductPreorderRequest`

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

IProductPreorderRequest

Product, optional guest contact details and currency.

src/lib/interfaces/orionplace/orders/IProductPreorder.ts

TypeScript

export interface IProductPreorderRequest {
  // Positive ID of an out-of-stock product with `EProductStatus.LOW_STOCK` or
  // `EProductStatus.LOW_SALE_STOCK` and a seller who accepts preorders.
  product: number;
  // Guest email address; at least email or phone is required for a guest.
  // Surrounding whitespace is removed and the address is stored in lowercase.
  email?: string | null;
  // Guest phone number, validated as a phone number. Prefer an international
  // number including the country calling code.
  phone?: string | null;
  // Optional currency ID from `init.currencies` for the order later made from
  // the preorder; without it, the request language’s default currency.
  currency?: number | null;
}