Skip to main content
GET
/
v1
/
inventory
/
availableFilters
Get available filter options for inventory search
curl --request GET \
  --url https://api.footwayplus.com/v1/inventory/availableFilters \
  --header 'X-API-KEY: <api-key>'
{
  "totalItems": 123,
  "merchants": {
    "total": 123,
    "values": [
      {
        "id": "<string>",
        "name": "<string>",
        "count": 123
      }
    ]
  },
  "vendors": {
    "total": 123,
    "values": [
      {
        "name": "<string>",
        "count": 123
      }
    ]
  },
  "departments": {
    "total": 123,
    "values": [
      {
        "name": "<string>",
        "count": 123
      }
    ]
  },
  "productGroups": {
    "total": 123,
    "values": [
      {
        "name": "<string>",
        "count": 123
      }
    ]
  },
  "productTypes": {
    "total": 123,
    "values": [
      {
        "name": "<string>",
        "count": 123
      }
    ]
  }
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

merchantId
string[]

Filter by merchant ID (can specify multiple)

vendor
string[]

Filter by vendor (can specify multiple)

department
string[]

Filter by department (can specify multiple)

productGroup
string[]

Filter by product group (can specify multiple)

productType
string[]

Filter by product type (can specify multiple)

Response

Available filter options

totalItems
integer

Total number of items matching the current filter selection

merchants
object
vendors
object
departments
object
productGroups
object
productTypes
object