Heartwork API

ProductIssues

Endpointhttps://api.heart.work

Download schema

Fetches a collection of all product issues

GET

https://api.heart.work

/core-api/catalog/products/issues

Fetches a collection of all product issues › query Parameters

take

integer · int32

skip

integer · int32

productIds

string[]

categoryIds

string[]

IsIgnored

boolean

Fetches a collection of all product issues › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/products/issues

curl --request GET \
  --url https://api.heart.work/core-api/catalog/products/issues

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "productId": "productId",
      "isIgnored": true,
      "type": "type"
    }
  ],
  "total": 0
}

plain

Update a product issue for ignored values

PUT

https://api.heart.work

/core-api/catalog/products/issues

Update a product issue for ignored values › Request Body

id

string · uuid · required

isIgnored

boolean · required

Update a product issue for ignored values › Responses

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, isIgnored, productId
	type = object · requires: id, isIgnored, language +1 more
	type = object · requires: attributeId, categoryId, id +2 more

Properties for Variant 1:

id

string · uuid · required

productId

string · required

isIgnored

boolean · required

type

string · required

PUT/core-api/catalog/products/issues

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/products/issues \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000",
  "isIgnored": true
}
'

shell

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "isIgnored": true
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "productId": "productId",
  "isIgnored": true,
  "type": "type"
}

plain

Fetches product issue statistics for provided categories

GET

https://api.heart.work

/core-api/catalog/products/issues/statistics

Fetches product issue statistics for provided categories › query Parameters

CategoryIds

string[]

Fetches product issue statistics for provided categories › Responses

object · required

total

integer · int32 · required

GET/core-api/catalog/products/issues/statistics

curl --request GET \
  --url https://api.heart.work/core-api/catalog/products/issues/statistics

shell

Example Responses

{
  "data": {},
  "total": 0
}

plain

ProductFilters ProductManufacturers

Heartwork API

ProductIssues

Endpointhttps://api.heart.work

Download schema

Fetches a collection of all product issues

GET

https://api.heart.work

/core-api/catalog/products/issues

Fetches a collection of all product issues › query Parameters

take

integer · int32

skip

integer · int32

productIds

string[]

categoryIds

string[]

IsIgnored

boolean

Fetches a collection of all product issues › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/products/issues

curl --request GET \
  --url https://api.heart.work/core-api/catalog/products/issues

shell

Example Responses

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "productId": "productId",
      "isIgnored": true,
      "type": "type"
    }
  ],
  "total": 0
}

plain

Update a product issue for ignored values

PUT

https://api.heart.work

/core-api/catalog/products/issues

Update a product issue for ignored values › Request Body

id

string · uuid · required

isIgnored

boolean · required

Update a product issue for ignored values › Responses

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, isIgnored, productId
	type = object · requires: id, isIgnored, language +1 more
	type = object · requires: attributeId, categoryId, id +2 more

Properties for Variant 1:

id

string · uuid · required

productId

string · required

isIgnored

boolean · required

type

string · required

PUT/core-api/catalog/products/issues

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/products/issues \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "00000000-0000-0000-0000-000000000000",
  "isIgnored": true
}
'

shell

Example Request Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "isIgnored": true
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "productId": "productId",
  "isIgnored": true,
  "type": "type"
}

plain

Fetches product issue statistics for provided categories

GET

https://api.heart.work

/core-api/catalog/products/issues/statistics

Fetches product issue statistics for provided categories › query Parameters

CategoryIds

string[]

Fetches product issue statistics for provided categories › Responses

object · required

total

integer · int32 · required

GET/core-api/catalog/products/issues/statistics

curl --request GET \
  --url https://api.heart.work/core-api/catalog/products/issues/statistics

shell

Example Responses

{
  "data": {},
  "total": 0
}

plain

ProductFilters ProductManufacturers