`IManufacturerSearchRequest`

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

IManufacturerSearchRequest

Search manufacturer records, browse one letter group or load a manufacturer by ID.

app/interfaces/orionplace/catalog/ICatalogDirectory.ts

TypeScript

export interface IManufacturerSearchRequest {
  // Optional directory search conditions.
  filters?: {
    // Exact manufacturer ID. Supplying a nonempty ID also enables category IDs
    // in the response.
    id?: number;
    // Exact manufacturer name.
    name?: string;
    // Case-insensitive name prefix, for example a letter from
    // `manufactures_manufactures_list_get`.
    name_starts?: string;
    // Ascending or descending manufacturer ID; default ascending.
    ordering?: 'id' | '-id';
  };
  // Page number and size.
  paginate?: IApiPaginationRequest;
}