Search product filter options

GET/api/products/filter-options/search

Searches category or vendor filter values for the product search UI.

Query Parameters

field*string

field.

Value in"category" | "vendor"

Example"category"

query?|

Query string or search text supplied by the caller.

Example"hydra"

limit?|

Maximum number of results to return.

Example20

Response Body

`application/json`

curl -X GET "https://loading/api/products/filter-options/search?field=category"

[
  {
    "value": "Acme",
    "label": "Acme",
    "facets": 0
  }
]

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Search product filter options

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`