Application Load

ISellerDirectoryRequest

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

ISellerDirectoryRequest

Public seller directory filters.

interfaces/orionplace/sellers/ISellerDirectory.ts
TypeScript
export interface ISellerDirectoryRequest extends Record<string, unknown> {
  // Seller selection conditions.
  filters?: {
    // Exact seller account ID.
    id?: number;
    // Case-insensitive part of the seller’s name.
    seller_name?: string;
    // Minimum seller rating, inclusive, counted from the approved reviews left
    // in this storefront’s store group.
    seller_rating_from?: number;
    // Maximum seller rating, inclusive, counted from the approved reviews left
    // in this storefront’s store group.
    seller_rating_to?: number;
    // Select seller accounts; the request sends an array of their IDs. Names
    // come from the registered reload source.
    sellers?: number[];
    // Select public category IDs. A seller matches if a product group belonging
    // to them is assigned to one of these categories; descendants are not added
    // automatically.
    seller_categories?: number[];
    // Sellers without products are excluded even when this is false.
    only_with_products?: boolean;
    // Sort by account ID or seller rating in this storefront’s store group.
    // Preserve the spaces, capitalization and spelling of these values.
    ordering?: 'By ID' | '-By ID' | 'seller_raiting' | '-seller_raiting';
  };
  // Requested page and page size.
  paginate?: IApiPaginationRequest;
}