Heartwork API

FavouriteProducts

Endpointhttps://api.heart.work

Download schema

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

GET

https://api.heart.work

/core-api/catalog/favouriteproducts

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

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

CreatedAt

ids

string[]

external_references

string[]

client_login_ids

string[]

product_ids

string[]

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

object[] · required

total

integer · int32 · required

GET/core-api/catalog/favouriteproducts

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "origin": "Personal",
      "product": {
        "id": "id",
        "name": "name",
        "type": "Product"
      },
      "clientLogin": {
        "id": "id",
        "name": "name",
        "type": "ClientLogin"
      }
    }
  ],
  "total": 0
}

plain

Creates a new product favourite

POST

https://api.heart.work

/core-api/catalog/favouriteproducts

Creates a new product favourite › Request Body

clientLoginId

string · required

productId

string · required

origin

string · enum · required

Enum values:

Personal

Suggested

Creates a new product favourite › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

origin

string · enum · required

Enum values:

Personal

Suggested

object · required

externalReference

string

POST/core-api/catalog/favouriteproducts

curl --request POST \
  --url https://api.heart.work/core-api/catalog/favouriteproducts \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientLoginId": "clientLoginId",
  "productId": "productId",
  "origin": "Personal"
}
'

shell

Example Request Body

{
  "clientLoginId": "clientLoginId",
  "productId": "productId",
  "origin": "Personal"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "origin": "Personal",
  "product": {
    "id": "id",
    "name": "name",
    "type": "Product"
  },
  "clientLogin": {
    "id": "id",
    "name": "name",
    "type": "ClientLogin"
  }
}

plain

POST

https://api.heart.work

/core-api/catalog/favouriteproducts/bulk

Request Body

object[] · required

Responses

object[] · required

total

integer · int32 · required

POST/core-api/catalog/favouriteproducts/bulk

curl --request POST \
  --url https://api.heart.work/core-api/catalog/favouriteproducts/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "clientLoginId": "clientLoginId",
      "productId": "productId",
      "origin": "Personal"
    }
  ]
}
'

shell

Example Request Body

{
  "items": [
    {
      "clientLoginId": "clientLoginId",
      "productId": "productId",
      "origin": "Personal"
    }
  ]
}

json

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "origin": "Personal",
      "product": {
        "id": "id",
        "name": "name",
        "type": "Product"
      },
      "clientLogin": {
        "id": "id",
        "name": "name",
        "type": "ClientLogin"
      }
    }
  ],
  "total": 0
}

plain

Deletes an existing product favourite

DELETE

https://api.heart.work

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

Deletes an existing product favourite › path Parameters

id

string · required

Deletes an existing product favourite › Responses

No data returned

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

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

shell

Example Responses

No example specified for this content type

Documents Identities

Heartwork API

FavouriteProducts

Endpointhttps://api.heart.work

Download schema

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

GET

https://api.heart.work

/core-api/catalog/favouriteproducts

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

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

CreatedAt

ids

string[]

external_references

string[]

client_login_ids

string[]

product_ids

string[]

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

object[] · required

total

integer · int32 · required

GET/core-api/catalog/favouriteproducts

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "origin": "Personal",
      "product": {
        "id": "id",
        "name": "name",
        "type": "Product"
      },
      "clientLogin": {
        "id": "id",
        "name": "name",
        "type": "ClientLogin"
      }
    }
  ],
  "total": 0
}

plain

Creates a new product favourite

POST

https://api.heart.work

/core-api/catalog/favouriteproducts

Creates a new product favourite › Request Body

clientLoginId

string · required

productId

string · required

origin

string · enum · required

Enum values:

Personal

Suggested

Creates a new product favourite › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

origin

string · enum · required

Enum values:

Personal

Suggested

object · required

externalReference

string

POST/core-api/catalog/favouriteproducts

curl --request POST \
  --url https://api.heart.work/core-api/catalog/favouriteproducts \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientLoginId": "clientLoginId",
  "productId": "productId",
  "origin": "Personal"
}
'

shell

Example Request Body

{
  "clientLoginId": "clientLoginId",
  "productId": "productId",
  "origin": "Personal"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "origin": "Personal",
  "product": {
    "id": "id",
    "name": "name",
    "type": "Product"
  },
  "clientLogin": {
    "id": "id",
    "name": "name",
    "type": "ClientLogin"
  }
}

plain

POST

https://api.heart.work

/core-api/catalog/favouriteproducts/bulk

Request Body

object[] · required

Responses

object[] · required

total

integer · int32 · required

POST/core-api/catalog/favouriteproducts/bulk

curl --request POST \
  --url https://api.heart.work/core-api/catalog/favouriteproducts/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "clientLoginId": "clientLoginId",
      "productId": "productId",
      "origin": "Personal"
    }
  ]
}
'

shell

Example Request Body

{
  "items": [
    {
      "clientLoginId": "clientLoginId",
      "productId": "productId",
      "origin": "Personal"
    }
  ]
}

json

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "origin": "Personal",
      "product": {
        "id": "id",
        "name": "name",
        "type": "Product"
      },
      "clientLogin": {
        "id": "id",
        "name": "name",
        "type": "ClientLogin"
      }
    }
  ],
  "total": 0
}

plain

Deletes an existing product favourite

DELETE

https://api.heart.work

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

Deletes an existing product favourite › path Parameters

id

string · required

Deletes an existing product favourite › Responses

No data returned

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

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

shell

Example Responses

No example specified for this content type

Documents Identities