inventoryMetadata Query

Description

Retrieves metadata and statistics for inventory items based on filter criteria, including pagination, categories, supplier codes, locations, and aggregate statistics.

query inventoryMetadata($filters: InventoryFilters!) {
  inventoryMetadata(filters: $filters) {
    categories
    supplierCodes
    locations
    pagination {
      limit
      count
      page
      pages
      hasMore
    }
    metadata {
      categories
      supplierCodes
      locations
    }
    stats {
      total
      stockCount
      listingsCount
    }
  }
}

Variables

{
    "filters": {
        "page": 1,
        "limit": 20,
        "stock": "stock",
        "type": "type",
        "itemTypes": [
            "itemTypes"
        ],
        "status": "status",
        "discogsStatus": "discogsStatus",
        "sort": "sort",
        "order": 42,
        "supplierCode": [
            "supplierCode"
        ],
        "condition": [
            "condition"
        ],
        "secondHand": true,
        "location": [
            "location"
        ],
        "locationSearch": "locationSearch",
        "categories": [
            "categories"
        ],
        "itemId": 30.7,
        "term": "term",
        "from": "from",
        "to": "to",
        "dateFilter": "dateFilter",
        "availableDate": [
            1719883915729
        ],
        "publishedDate": [
            1739577168978
        ],
        "createdDate": [
            1742530911578
        ],
        "preOrder": true,
        "labels": [
            42
        ],
        "sleeveCondition": [
            "sleeveCondition"
        ],
        "hasSnippet": "hasSnippet",
        "artists": [
            30.7
        ],
        "styles": [
            "styles"
        ],
        "genres": [
            "genres"
        ],
        "formatDescriptions": [
            "formatDescriptions"
        ],
        "formats": [
            "formats"
        ],
        "years": [
            42
        ],
        "listingRefs": [
            "listingRefs"
        ],
        "filteredIds": [
            "2a043796a4912d6b1e9c55ec"
        ],
        "createdBy": "274b9d32fc9a35bf10d0cb9f",
        "countries": [
            "Canada"
        ],
        "manufacturers": [
            "manufacturers"
        ],
        "productTypes": [
            "productTypes"
        ],
        "giftCards": true
    }
}

Response

{
    "inventoryMetadata": {
        "categories": [
            "example"
        ],
        "supplierCodes": [
            "example"
        ],
        "locations": [
            "example"
        ],
        "pagination": {
            "limit": 20,
            "count": 10,
            "page": 1,
            "pages": 1,
            "hasMore": true
        },
        "metadata": {
            "categories": [
                "example"
            ],
            "supplierCodes": [
                "example"
            ],
            "locations": [
                "example"
            ]
        },
        "stats": {
            "total": 29.99,
            "stockCount": 1.23,
            "listingsCount": 1.23
        }
    }
}

Arguments

Name	Type	Description
filters	InventoryFilters!	Comprehensive filter input for inventory queries.

Returns

InventoryMetadata