Bundle Ecommerce

Get Index Fields

Changed on

Get all available index fields with optional filtering by filter groups and tenant

get/pimcore-studio/api/bundle/ecommerce/fields

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/bundle/ecommerce/fields
  • Auth: none declared

Query parameters

filtergroupstring
Example:category,price

Filter by specific filter groups, comma separated

tenantstring

Filter by tenant

showAllFieldsboolean

Show all fields including hidden ones

addEmptyboolean

Add an empty option at the beginning

specificPriceFieldboolean

Add the specific price field

Response

Index fields collection

totalItemsinteger required

Example response

{
  "totalItems": 666,
  "items": [
    {
      "key": "productName",
      "name": "Product Name"
    }
  ]
}

Changes