Heartwork API

Brands

Endpointhttps://api.heart.work

Download schema

Fetches a collection of brands, optionally filtered by search criteria.

GET

https://api.heart.work

/core-api/catalog/brands

Fetches a collection of brands, optionally filtered by search criteria. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Name

Query

string

ids

string[]

external_references

string[]

Fetches a collection of brands, optionally filtered by search criteria. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/brands

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "imageUrl": "imageUrl",
      "visibilitySettings": {
        "showOnHome": true
      }
    }
  ],
  "total": 0
}

plain

Creates and stores a new brand.

POST

https://api.heart.work

/core-api/catalog/brands

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

Creates and stores a new brand. › Request Body

name

string · required

externalReference

string

imageUrl

string

object

Creates and stores a new brand. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

object · required

externalReference

string

imageUrl

string

POST/core-api/catalog/brands

curl --request POST \
  --url https://api.heart.work/core-api/catalog/brands \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "name": "name",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  }
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "name": "name",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  }
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  }
}

plain

Fetches a single brand, by id.

GET

https://api.heart.work

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

Fetches a single brand, by id. › path Parameters

id

string · required

Unique id of the brand to fetch.

Fetches a single brand, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

object · required

externalReference

string

imageUrl

string

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

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  }
}

plain

Updates an existing brand, replacing it entirely.

PUT

https://api.heart.work

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

On success, returns the updated entity in the response.

Updates an existing brand, replacing it entirely. › path Parameters

id

string · required

Updates an existing brand, replacing it entirely. › Request Body

name

string · required

id

string · required

externalReference

string

imageUrl

string

object

Updates an existing brand, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

object · required

externalReference

string

imageUrl

string

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

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/brands/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "name": "name",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  },
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "name": "name",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  },
  "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",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  }
}

plain

Deletes an existing brand, by id.

DELETE

https://api.heart.work

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

Deletes an existing brand, by id. › path Parameters

id

string · required

Unique id of the brand to delete.

Deletes an existing brand, by id. › Responses

No data returned

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

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

shell

Example Responses

No example specified for this content type

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

POST

https://api.heart.work

/core-api/catalog/brands/images

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

images

string[]

The images to upload

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

fileUris

string[] · required

POST/core-api/catalog/brands/images

curl --request POST \
  --url https://api.heart.work/core-api/catalog/brands/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

Auth Catalogs

Heartwork API

Brands

Endpointhttps://api.heart.work

Download schema

Fetches a collection of brands, optionally filtered by search criteria.

GET

https://api.heart.work

/core-api/catalog/brands

Fetches a collection of brands, optionally filtered by search criteria. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Name

Query

string

ids

string[]

external_references

string[]

Fetches a collection of brands, optionally filtered by search criteria. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/brands

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "imageUrl": "imageUrl",
      "visibilitySettings": {
        "showOnHome": true
      }
    }
  ],
  "total": 0
}

plain

Creates and stores a new brand.

POST

https://api.heart.work

/core-api/catalog/brands

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

Creates and stores a new brand. › Request Body

name

string · required

externalReference

string

imageUrl

string

object

Creates and stores a new brand. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

object · required

externalReference

string

imageUrl

string

POST/core-api/catalog/brands

curl --request POST \
  --url https://api.heart.work/core-api/catalog/brands \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "name": "name",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  }
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "name": "name",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  }
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  }
}

plain

Fetches a single brand, by id.

GET

https://api.heart.work

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

Fetches a single brand, by id. › path Parameters

id

string · required

Unique id of the brand to fetch.

Fetches a single brand, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

object · required

externalReference

string

imageUrl

string

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

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  }
}

plain

Updates an existing brand, replacing it entirely.

PUT

https://api.heart.work

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

On success, returns the updated entity in the response.

Updates an existing brand, replacing it entirely. › path Parameters

id

string · required

Updates an existing brand, replacing it entirely. › Request Body

name

string · required

id

string · required

externalReference

string

imageUrl

string

object

Updates an existing brand, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

object · required

externalReference

string

imageUrl

string

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

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/brands/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "name": "name",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  },
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "name": "name",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  },
  "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",
  "imageUrl": "imageUrl",
  "visibilitySettings": {
    "showOnHome": true
  }
}

plain

Deletes an existing brand, by id.

DELETE

https://api.heart.work

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

Deletes an existing brand, by id. › path Parameters

id

string · required

Unique id of the brand to delete.

Deletes an existing brand, by id. › Responses

No data returned

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

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

shell

Example Responses

No example specified for this content type

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

POST

https://api.heart.work

/core-api/catalog/brands/images

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

images

string[]

The images to upload

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

fileUris

string[] · required

POST/core-api/catalog/brands/images

curl --request POST \
  --url https://api.heart.work/core-api/catalog/brands/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

Auth Catalogs