Heartwork API

ProductFilters

Endpointhttps://api.heart.work

Download schema

Updates a collection of product filters

PUT

https://api.heart.work

/core-api/catalog/products/filters

Updates a collection of product filters › Request Body

object[]

categoryId

string · required

attributeId

string · required

displayOrder

integer · int32 · required

isActive

boolean · required

object[] · required

Updates a collection of product filters › Responses

object[] · required

PUT/core-api/catalog/products/filters

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/products/filters \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "categoryId": "categoryId",
    "attributeId": "attributeId",
    "displayOrder": 0,
    "isActive": true,
    "options": [
      {
        "value": "value",
        "label": "label",
        "displayOrder": 0,
        "isActive": true
      }
    ]
  }
]
'

shell

Example Request Body

[
  {
    "categoryId": "categoryId",
    "attributeId": "attributeId",
    "displayOrder": 0,
    "isActive": true,
    "options": [
      {
        "value": "value",
        "label": "label",
        "displayOrder": 0,
        "isActive": true
      }
    ]
  }
]

json

Example Responses

{
  "filters": [
    {
      "attributeId": "attributeId",
      "attributeName": "attributeName",
      "categoryId": "categoryId",
      "displayOrder": 0,
      "isActive": true,
      "options": [
        {
          "label": "label",
          "value": "value",
          "count": 0,
          "displayOrder": 0,
          "isActive": true
        }
      ]
    }
  ]
}

plain

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690

POST

https://api.heart.work

/core-api/catalog/products/filters

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Request Body

query

string

catalogId

string

categoryId

string

isActive

boolean

object[]

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Responses

object[] · required

POST/core-api/catalog/products/filters

curl --request POST \
  --url https://api.heart.work/core-api/catalog/products/filters \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "query",
  "catalogId": "catalogId",
  "categoryId": "categoryId",
  "isActive": true,
  "activeFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "query": "query",
  "catalogId": "catalogId",
  "categoryId": "categoryId",
  "isActive": true,
  "activeFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ]
}

json

Example Responses

{
  "filters": [
    {
      "attributeId": "attributeId",
      "attributeName": "attributeName",
      "categoryId": "categoryId",
      "displayOrder": 0,
      "isActive": true,
      "options": [
        {
          "label": "label",
          "value": "value",
          "count": 0,
          "displayOrder": 0,
          "isActive": true
        }
      ]
    }
  ]
}

plain

ProductDisplayContents ProductIssues

Heartwork API

ProductFilters

Endpointhttps://api.heart.work

Download schema

Updates a collection of product filters

PUT

https://api.heart.work

/core-api/catalog/products/filters

Updates a collection of product filters › Request Body

object[]

categoryId

string · required

attributeId

string · required

displayOrder

integer · int32 · required

isActive

boolean · required

object[] · required

Updates a collection of product filters › Responses

object[] · required

PUT/core-api/catalog/products/filters

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/products/filters \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "categoryId": "categoryId",
    "attributeId": "attributeId",
    "displayOrder": 0,
    "isActive": true,
    "options": [
      {
        "value": "value",
        "label": "label",
        "displayOrder": 0,
        "isActive": true
      }
    ]
  }
]
'

shell

Example Request Body

[
  {
    "categoryId": "categoryId",
    "attributeId": "attributeId",
    "displayOrder": 0,
    "isActive": true,
    "options": [
      {
        "value": "value",
        "label": "label",
        "displayOrder": 0,
        "isActive": true
      }
    ]
  }
]

json

Example Responses

{
  "filters": [
    {
      "attributeId": "attributeId",
      "attributeName": "attributeName",
      "categoryId": "categoryId",
      "displayOrder": 0,
      "isActive": true,
      "options": [
        {
          "label": "label",
          "value": "value",
          "count": 0,
          "displayOrder": 0,
          "isActive": true
        }
      ]
    }
  ]
}

plain

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690

POST

https://api.heart.work

/core-api/catalog/products/filters

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Request Body

query

string

catalogId

string

categoryId

string

isActive

boolean

object[]

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Responses

object[] · required

POST/core-api/catalog/products/filters

curl --request POST \
  --url https://api.heart.work/core-api/catalog/products/filters \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "query",
  "catalogId": "catalogId",
  "categoryId": "categoryId",
  "isActive": true,
  "activeFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "query": "query",
  "catalogId": "catalogId",
  "categoryId": "categoryId",
  "isActive": true,
  "activeFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ]
}

json

Example Responses

{
  "filters": [
    {
      "attributeId": "attributeId",
      "attributeName": "attributeName",
      "categoryId": "categoryId",
      "displayOrder": 0,
      "isActive": true,
      "options": [
        {
          "label": "label",
          "value": "value",
          "count": 0,
          "displayOrder": 0,
          "isActive": true
        }
      ]
    }
  ]
}

plain

ProductDisplayContents ProductIssues