`IOrderHistoryRequest`

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

IOrderHistoryRequest

Order filters and pagination.

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

TypeScript

export interface IOrderHistoryRequest {
  // Optional order selection.
  filters?: {
    // One order ID belonging to the user.
    id?: number;
    // Comma-separated order IDs, for example `1,2,3`; a numeric array is also
    // accepted.
    id__in?: number[] | string;
    // Match any selected order state.
    order_status?: EOrderStatus[];
    // Order group. `EOrderTab.IN_WORK` also includes finished orders with
    // undelivered shipments; `EOrderTab.FINISHED` requires all shipments
    // delivered.
    order_tab?: EOrderTab;
    // Order by ID: `-id` for newest first (default), `id` for oldest first.
    ordering?: 'id' | '-id';
  };
  // Page 1 and 15 items by default; maximum 35.
  paginate?: IApiPaginationRequest;
}