Heartwork API

ProductCategoryDisplayContent

Endpointhttps://api.heart.work

Download schema

Fetches a single product display content, by id.

GET

https://api.heart.work

/core-api/catalog/productcategories/content/{id}

Fetches a single product display content, by id. › path Parameters

id

string · required

Unique id of the product display content to fetch.

Fetches a single product display content, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

descriptionFormat

string · enum · required

Enum values:

Markdown

Html

language

string · required

object · required

externalReference

string

excerpt

string

description

string

GET/core-api/catalog/productcategories/content/{id}

curl --request GET \
  --url https://api.heart.work/core-api/catalog/productcategories/content/:id

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "language": "language",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "productCategory": {
    "id": "id",
    "name": "name",
    "type": "ProductCategory"
  }
}

plain

Updates an existing product display content, replacing it entirely.

PUT

https://api.heart.work

/core-api/catalog/productcategories/content/{id}

On success, returns the updated entity in the response.

Updates an existing product display content, replacing it entirely. › path Parameters

id

string · required

Updates an existing product display content, replacing it entirely. › Request Body

title

string · required

descriptionFormat

string · enum · required

Enum values:

Markdown

Html

id

string · required

externalReference

string

excerpt

string

description

string

object

Updates an existing product display content, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

descriptionFormat

string · enum · required

Enum values:

Markdown

Html

language

string · required

object · required

externalReference

string

excerpt

string

description

string

PUT/core-api/catalog/productcategories/content/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/productcategories/content/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "language": "language",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "productCategory": {
    "id": "id",
    "name": "name",
    "type": "ProductCategory"
  }
}

plain

Deletes an existing product display content, by id.

DELETE

https://api.heart.work

/core-api/catalog/productcategories/content/{id}

Deletes an existing product display content, by id. › path Parameters

id

string · required

Unique id of the product display content to delete.

Deletes an existing product display content, by id. › Responses

No data returned

DELETE/core-api/catalog/productcategories/content/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/catalog/productcategories/content/:id

shell

Example Responses

No example specified for this content type

Fetches a list of product display contents.

GET

https://api.heart.work

/core-api/catalog/productcategories/content

Fetches a list of product display contents. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Title

Query

string

ids

string[]

external_references

string[]

languages

string[]

product_category_ids

string[]

Fetches a list of product display contents. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/productcategories/content

curl --request GET \
  --url https://api.heart.work/core-api/catalog/productcategories/content

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "title": "title",
      "excerpt": "excerpt",
      "description": "description",
      "descriptionFormat": "Markdown",
      "language": "language",
      "seoMeta": {
        "title": "title",
        "keywords": "keywords",
        "description": "description"
      },
      "productCategory": {
        "id": "id",
        "name": "name",
        "type": "ProductCategory"
      }
    }
  ],
  "total": 0
}

plain

Creates and stores a new product display content.

POST

https://api.heart.work

/core-api/catalog/productcategories/content

On success, returns the newly created entity in the response.

Creates and stores a new product display content. › Request Body

title

string · required

descriptionFormat

string · enum · required

Enum values:

Markdown

Html

language

string · required

productCategoryId

string · required

externalReference

string

excerpt

string

description

string

object

Creates and stores a new product display content. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

descriptionFormat

string · enum · required

Enum values:

Markdown

Html

language

string · required

object · required

externalReference

string

excerpt

string

description

string

POST/core-api/catalog/productcategories/content

curl --request POST \
  --url https://api.heart.work/core-api/catalog/productcategories/content \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "language": "language",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "productCategoryId": "productCategoryId"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "language": "language",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "productCategoryId": "productCategoryId"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "language": "language",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "productCategory": {
    "id": "id",
    "name": "name",
    "type": "ProductCategory"
  }
}

plain

ProductCategories ProductDisplayContents

Heartwork API

ProductCategoryDisplayContent

Endpointhttps://api.heart.work

Download schema

Fetches a single product display content, by id.

GET

https://api.heart.work

/core-api/catalog/productcategories/content/{id}

Fetches a single product display content, by id. › path Parameters

id

string · required

Unique id of the product display content to fetch.

Fetches a single product display content, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

descriptionFormat

string · enum · required

Enum values:

Markdown

Html

language

string · required

object · required

externalReference

string

excerpt

string

description

string

GET/core-api/catalog/productcategories/content/{id}

curl --request GET \
  --url https://api.heart.work/core-api/catalog/productcategories/content/:id

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "language": "language",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "productCategory": {
    "id": "id",
    "name": "name",
    "type": "ProductCategory"
  }
}

plain

Updates an existing product display content, replacing it entirely.

PUT

https://api.heart.work

/core-api/catalog/productcategories/content/{id}

On success, returns the updated entity in the response.

Updates an existing product display content, replacing it entirely. › path Parameters

id

string · required

Updates an existing product display content, replacing it entirely. › Request Body

title

string · required

descriptionFormat

string · enum · required

Enum values:

Markdown

Html

id

string · required

externalReference

string

excerpt

string

description

string

object

Updates an existing product display content, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

descriptionFormat

string · enum · required

Enum values:

Markdown

Html

language

string · required

object · required

externalReference

string

excerpt

string

description

string

PUT/core-api/catalog/productcategories/content/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/productcategories/content/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "language": "language",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "productCategory": {
    "id": "id",
    "name": "name",
    "type": "ProductCategory"
  }
}

plain

Deletes an existing product display content, by id.

DELETE

https://api.heart.work

/core-api/catalog/productcategories/content/{id}

Deletes an existing product display content, by id. › path Parameters

id

string · required

Unique id of the product display content to delete.

Deletes an existing product display content, by id. › Responses

No data returned

DELETE/core-api/catalog/productcategories/content/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/catalog/productcategories/content/:id

shell

Example Responses

No example specified for this content type

Fetches a list of product display contents.

GET

https://api.heart.work

/core-api/catalog/productcategories/content

Fetches a list of product display contents. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Title

Query

string

ids

string[]

external_references

string[]

languages

string[]

product_category_ids

string[]

Fetches a list of product display contents. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/productcategories/content

curl --request GET \
  --url https://api.heart.work/core-api/catalog/productcategories/content

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "title": "title",
      "excerpt": "excerpt",
      "description": "description",
      "descriptionFormat": "Markdown",
      "language": "language",
      "seoMeta": {
        "title": "title",
        "keywords": "keywords",
        "description": "description"
      },
      "productCategory": {
        "id": "id",
        "name": "name",
        "type": "ProductCategory"
      }
    }
  ],
  "total": 0
}

plain

Creates and stores a new product display content.

POST

https://api.heart.work

/core-api/catalog/productcategories/content

On success, returns the newly created entity in the response.

Creates and stores a new product display content. › Request Body

title

string · required

descriptionFormat

string · enum · required

Enum values:

Markdown

Html

language

string · required

productCategoryId

string · required

externalReference

string

excerpt

string

description

string

object

Creates and stores a new product display content. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

title

string · required

descriptionFormat

string · enum · required

Enum values:

Markdown

Html

language

string · required

object · required

externalReference

string

excerpt

string

description

string

POST/core-api/catalog/productcategories/content

curl --request POST \
  --url https://api.heart.work/core-api/catalog/productcategories/content \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "language": "language",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "productCategoryId": "productCategoryId"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "language": "language",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "productCategoryId": "productCategoryId"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "title": "title",
  "excerpt": "excerpt",
  "description": "description",
  "descriptionFormat": "Markdown",
  "language": "language",
  "seoMeta": {
    "title": "title",
    "keywords": "keywords",
    "description": "description"
  },
  "productCategory": {
    "id": "id",
    "name": "name",
    "type": "ProductCategory"
  }
}

plain

ProductCategories ProductDisplayContents