Heartwork API

ProductCategories

Endpointhttps://api.heart.work

Download schema

Fetches a collection of all product categories, for the provided workspace

GET

https://api.heart.work

/core-api/catalog/productcategories

Fetches a collection of all product categories, for the provided workspace › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Name

DisplayOrder

Query

string

ids

string[]

external_references

string[]

parent_ids

string[]

visibility_show_in_menu

boolean

Fetches a collection of all product categories, for the provided workspace › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/productcategories

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "image": "image",
      "slug": "slug",
      "parent": {
        "id": "id",
        "name": "name",
        "type": "ProductCategory"
      },
      "active": true,
      "visibility": {
        "showInMenu": true
      },
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "displayOrder": 0
    }
  ],
  "total": 0
}

plain

Creates and stores a new product category.

POST

https://api.heart.work

/core-api/catalog/productcategories

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

Creates and stores a new product category. › Request Body

name

string · required

active

boolean · required

displayOrder

integer · int32 · required

externalReference

string

image

string

parentId

string

object

object[]

Creates and stores a new product category. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

slug

string · required

active

boolean · required

object · required

object[] · required

displayOrder

integer · int32 · required

externalReference

string

image

string

object

POST/core-api/catalog/productcategories

curl --request POST \
  --url https://api.heart.work/core-api/catalog/productcategories \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "name": "name",
  "image": "image",
  "parentId": "parentId",
  "active": true,
  "visibility": {
    "showInMenu": true
  },
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "name": "name",
  "image": "image",
  "parentId": "parentId",
  "active": true,
  "visibility": {
    "showInMenu": true
  },
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "image": "image",
  "slug": "slug",
  "parent": {
    "id": "id",
    "name": "name",
    "type": "ProductCategory"
  },
  "active": true,
  "visibility": {
    "showInMenu": true
  },
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0
}

plain

Fetches a hierarchy of all product categories, for the provided workspace

GET

https://api.heart.work

/core-api/catalog/productcategories/hierarchy

Fetches a hierarchy of all product categories, for the provided workspace › query Parameters

sort_order

string · enum

Enum values:

Asc

Desc

sort_by

string · enum

Enum values:

Name

DisplayOrder

show_in_menu

boolean

Fetches a hierarchy of all product categories, for the provided workspace › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/productcategories/hierarchy

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "title": "title",
      "parentId": "parentId",
      "slug": "slug",
      "displayOrder": 0,
      "name": "name",
      "image": "image",
      "language": "language",
      "children": [
        null
      ]
    }
  ],
  "total": 0
}

plain

Fetches a single product category, by id.

GET

https://api.heart.work

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

Fetches a single product category, by id. › path Parameters

id

string · required

Unique id of the product category to fetch.

Fetches a single product category, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

slug

string · required

active

boolean · required

object · required

object[] · required

displayOrder

integer · int32 · required

externalReference

string

image

string

object

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

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "image": "image",
  "slug": "slug",
  "parent": {
    "id": "id",
    "name": "name",
    "type": "ProductCategory"
  },
  "active": true,
  "visibility": {
    "showInMenu": true
  },
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0
}

plain

Updates an existing product category, replacing it entirely.

PUT

https://api.heart.work

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

On success, returns the updated entity in the response.

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

id

string · required

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

name

string · required

active

boolean · required

displayOrder

integer · int32 · required

id

string · required

externalReference

string

image

string

parentId

string

object

object[]

Updates an existing product category, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

slug

string · required

active

boolean · required

object · required

object[] · required

displayOrder

integer · int32 · required

externalReference

string

image

string

object

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

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/productcategories/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "name": "name",
  "image": "image",
  "parentId": "parentId",
  "active": true,
  "visibility": {
    "showInMenu": true
  },
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0,
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "name": "name",
  "image": "image",
  "parentId": "parentId",
  "active": true,
  "visibility": {
    "showInMenu": true
  },
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0,
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "image": "image",
  "slug": "slug",
  "parent": {
    "id": "id",
    "name": "name",
    "type": "ProductCategory"
  },
  "active": true,
  "visibility": {
    "showInMenu": true
  },
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0
}

plain

Deletes an existing product category, by id.

DELETE

https://api.heart.work

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

Deletes an existing product category, by id. › path Parameters

id

string · required

Unique id of the product category to delete.

Deletes an existing product category, by id. › Responses

No data returned

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

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

shell

Example Responses

No example specified for this content type

Fetches a single product category, by slug.

GET

https://api.heart.work

/core-api/catalog/productcategories/slug/{slug}

Fetches a single product category, by slug. › path Parameters

slug

string · required

Slug of the product category to fetch.

Fetches a single product category, by slug. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

slug

string · required

active

boolean · required

object · required

object[] · required

displayOrder

integer · int32 · required

externalReference

string

image

string

object

GET/core-api/catalog/productcategories/slug/{slug}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "image": "image",
  "slug": "slug",
  "parent": {
    "id": "id",
    "name": "name",
    "type": "ProductCategory"
  },
  "active": true,
  "visibility": {
    "showInMenu": true
  },
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0
}

plain

Upload file to the cdn for product categories, images have to be added to the product categories afterwards

POST

https://api.heart.work

/core-api/catalog/productcategories/images

Upload file to the cdn for product categories, images have to be added to the product categories afterwards › Request Body

images

string[]

The images to upload

Upload file to the cdn for product categories, images have to be added to the product categories afterwards › Responses

fileUris

string[] · required

POST/core-api/catalog/productcategories/images

curl --request POST \
  --url https://api.heart.work/core-api/catalog/productcategories/images \
  --header 'Content-Type: multipart/form-data' \
  --form images=string

shell

Example Request Body

{
  "images": [
    "string"
  ]
}

json

Example Responses

{
  "fileUris": [
    "https://www.example.com/path/to/resource"
  ]
}

plain

ProductAttributes ProductCategoryDisplayContent