Application Load

IOrderShipmentItem

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

IOrderShipmentItem

One purchased product line in a shipment.

app/interfaces/orionplace/orders/IOrderHistory.ts
TypeScript
export interface IOrderShipmentItem {
  // Shipment-line ID for `customer_tickets_order_item_add`.
  id: number;
  // Owning shipment ID.
  dlf_id: number;
  // Owning order ID.
  order_id: number;
  // Purchased quantity in this shipment line.
  quantity: number;
  // Product, option and combined totals by currency.
  prices: IOrderLinePrices;
  // Product data, or `null` if unavailable.
  product: IProduct | null;
  // `true` while `refund_window` is not null: a return request can be created
  // for this item. The backend accepts one open request per item at a time.
  refund_allowed: boolean;
  // null: no return request now. Older backends send `refund_allowed` only.
  // Return request this item accepts now: `regular` inside the return period,
  // `defect` after it (only a request with `is_defect: true`), `null` none. One
  // open request per item at a time.
  refund_window?: OrderRefundWindow | null;
  // Units of this item at each stage of its return.
  refund_stats: IOrderItemRefundStats;
  // The return conversation of this item, with the return shipment it belongs
  // to, when one exists.
  ticket?: ICustomerTicket;
  // Saved option groups and selected additional products.
  option_groups: IOrderOptionGroup[];
  // Digital-content text and file references; can be empty.
  digital_stock: IOrderDigitalAttachment[];
}