InventoryFilters Input

Description

Comprehensive filter input for inventory queries, supporting filtering by stock, status, type, location, categories, dates, and more. Used by the inventory and inventoryMetadata queries.

Declaration

input InventoryFilters {
    page: Int
    limit: Int
    stock: String
    type: String
    itemTypes: [String!]
    status: String
    discogsStatus: String
    sort: String
    order: Int
    supplierCode: [String!]
    suppliers: [String!]
    condition: [String!]
    secondHand: Boolean
    location: [String!]
    locationSearch: String
    categories: [String!]
    itemId: String
    term: String
    from: String
    to: String
    dateFilter: String
    availableDate: [Date]
    publishedDate: [Date]
    createdDate: [Date]
    preOrder: Boolean
    compareAtPrice: Boolean
    publicComment: Boolean
    privateComment: Boolean
    onePerCustomer: Boolean
    labels: [Long!]
    sleeveCondition: [String!]
    hasSnippet: String
    hasAudio: Boolean
    artists: [Float!]
    styles: [String!]
    genres: [String!]
    formatDescriptions: [String!]
    formats: [String!]
    years: [Int!]
    listingRefs: [String!]
    filteredIds: [ID!]
    createdBy: ID
    countries: [String!]
    manufacturers: [String!]
    productTypes: [String!]
    giftCards: Boolean
}

Fields

Name	Type	Description
page	Int	The requested page number. Defaults to 1 if not specified.
limit	Int	Number of items per page. You can request a specific page size, and it will be used if it does not exceed the server-enforced maximum. If your requested size exceeds the maximum, the server will enforce the maximum limit.
stock	String	Stock filter. Valid values include "inStock" (items with stock > 0), "outOfStock" (items with stock = 0), or "all" (no stock filtering).
type ⚠️	String	Item type filter (e.g., "ReleaseItem", "BookItem", "ProductItem"). This field is deprecated; use itemTypes instead. ⚠️ Deprecated: Use itemTypes instead
itemTypes	[String!]	List of item types to filter by. Valid values include "ReleaseItem", "BookItem", or "ProductItem".
status	String	Listing status filter. Valid values include "published" (visible to customers), "draft" (not visible), or "private" (visible only to admins).
discogsStatus	String	Discogs listing status filter. Valid values include "listed" (listed on Discogs), "unlisted" (not listed on Discogs), or "all" (no filtering).
sort	String	Field name to sort results by. Valid values include "created" (creation date), "title" (item title), "stock" (stock quantity), or other item fields.
order	Int	Sort order: 1 for ascending, -1 for descending.
supplierCode	[String!]	List of supplier codes to filter by.
suppliers	[String!]	List of supplier IDs to filter by.
condition	[String!]	List of media condition values to filter by (e.g., "Mint", "Near Mint", "Very Good", "Good", "Fair", "Poor").
secondHand	Boolean	Whether to filter for second-hand items only. If true, returns only listings marked as second-hand.
location	[String!]	List of location names to filter by.
locationSearch	String	Search term to filter locations by name.
categories	[String!]	List of category names to filter by.
itemId	String	Specific item ID to filter by.
term	String	Search term to filter items by. Performs a case-insensitive search on item titles, descriptions, barcodes, SKUs, identifiers, or IDs.
from ⚠️	String	Start date for date range filtering. This field is deprecated; use date filters (availableDate, publishedDate, createdDate) instead. ⚠️ Deprecated: Use date filters instead
to ⚠️	String	End date for date range filtering. This field is deprecated; use date filters (availableDate, publishedDate, createdDate) instead. ⚠️ Deprecated: Use date filters instead
dateFilter ⚠️	String	Date filter type. This field is deprecated; use specific date filters (availableDate, publishedDate, createdDate) instead. ⚠️ Deprecated: Use date filters instead
availableDate	[Date]	Date range filter for listing available dates. Provide an array with two Date values: [startDate, endDate].
publishedDate	[Date]	Date range filter for listing published dates. Provide an array with two Date values: [startDate, endDate].
createdDate	[Date]	Date range filter for item creation dates. Provide an array with two Date values: [startDate, endDate].
preOrder	Boolean	Whether to filter for pre-order listings only. If true, returns only listings marked as pre-order.
compareAtPrice	Boolean	Whether to filter by sale price (compare-at price). If true, returns only listings with a compare-at price set (discounted); if false, only listings without one.
publicComment	Boolean	Whether the listing carries a public comment — the one the storefront shows. If true, returns only listings whose comment is set and not empty; if false, only listings without one.
privateComment	Boolean	Whether the listing carries a private comment — the one only the shop sees. If true, returns only listings whose private comment is set and not empty; if false, only listings without one.
onePerCustomer	Boolean	Whether the listing is limited to one per customer. If true, returns only listings marked as such; if false, only the others.
labels	[Long!]	List of label IDs to filter by. Long rather than Int, and it must stay that way: a label added by hand carries no Discogs id, so edit.release.tsx falls back to new Date().getTime(). Those ids are around 1.79e12, well past the 2,147,483,647 ceiling of a 32-bit Int, and GraphQL rejected them during variable coercion — before any resolver ran — so filtering by a shop's own label failed outright. ItemLabelsResultLabel.id is already Long, so this makes the value the API hands out usable as the value it takes back.
sleeveCondition	[String!]	List of sleeve condition values to filter by (e.g., "Mint", "Near Mint", "Very Good", "Good", "Fair", "Poor").
hasSnippet	String	Deprecated: Filter for items with audio snippets. Valid values include "true" (items with snippets), "false" (items without snippets), or "all" (no filtering).
hasAudio	Boolean	Filter for items with audio available. Valid values include true (items with audio), false (items without audio), undefined (no filtering).
artists	[Float!]	List of artist IDs (Discogs IDs) to filter by.
styles	[String!]	List of style names to filter by (e.g., "House", "Techno", "Ambient").
genres	[String!]	List of genre names to filter by (e.g., "Electronic", "Rock", "Jazz").
formatDescriptions	[String!]	List of format description strings to filter by (e.g., "LP", "CD", "Cassette", "7"", "12"").
formats	[String!]	List of format names to filter by (e.g., "Vinyl", "CD", "Cassette").
years	[Int!]	List of release years to filter by.
listingRefs	[String!]	List of listing reference IDs to filter by. Returns items that contain any of these listings.
filteredIds	[ID!]	List of item reference IDs to filter by. Returns only items with these specific reference IDs.
createdBy	ID	Reference ID of the admin user who created the item. Filters items created by this specific admin.
countries	[String!]	List of country codes to filter by (ISO 3166-1 alpha-2 format, e.g., "US", "GB", "FR").
manufacturers	[String!]	List of manufacturer names to filter by.
productTypes	[String!]	List of product type names to filter by.
giftCards	Boolean	Whether to filter for gift card products only. If true, returns only product items configured to generate gift cards.