Heartwork API

Catalogs

Endpointhttps://api.heart.work

Download schema

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

GET

https://api.heart.work

/core-api/catalog

Fetches a collection of all product catalogs, 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

Query

string

ids

string[]

external_references

string[]

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

object[] · required

total

integer · int32 · required

GET/core-api/catalog

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "categoryCount": 0,
      "productCount": 0
    }
  ],
  "total": 0
}

plain

Creates and stores a new product catalog.

POST

https://api.heart.work

/core-api/catalog

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

Creates and stores a new product catalog. › Request Body

name

string · required

externalReference

string

Creates and stores a new product catalog. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

categoryCount

integer · int32 · required

productCount

integer · int32 · required

externalReference

string

POST/core-api/catalog

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

shell

Example Request Body

{
  "externalReference": "externalReference",
  "name": "name"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "categoryCount": 0,
  "productCount": 0
}

plain

Fetches a single product catalog, by id.

GET

https://api.heart.work

/core-api/catalog/{id}

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

id

string · required

Unique id of the product catalog to fetch.

Fetches a single product catalog, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

categoryCount

integer · int32 · required

productCount

integer · int32 · required

externalReference

string

GET/core-api/catalog/{id}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "categoryCount": 0,
  "productCount": 0
}

plain

Updates an existing product catalog, replacing it entirely.

PUT

https://api.heart.work

/core-api/catalog/{id}

On success, returns the updated entity in the response.

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

id

string · required

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

name

string · required

id

string · required

externalReference

string

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

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

categoryCount

integer · int32 · required

productCount

integer · int32 · required

externalReference

string

PUT/core-api/catalog/{id}

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

shell

Example Request Body

{
  "externalReference": "externalReference",
  "name": "name",
  "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",
  "categoryCount": 0,
  "productCount": 0
}

plain

Deletes an existing product catalog, by id.

DELETE

https://api.heart.work

/core-api/catalog/{id}

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

id

string · required

Unique id of the product to delete.

Deletes an existing product catalog, by id. › Responses

No data returned

DELETE/core-api/catalog/{id}

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

shell

Example Responses

No example specified for this content type

Brands Comments

Heartwork API

Catalogs

Endpointhttps://api.heart.work

Download schema

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

GET

https://api.heart.work

/core-api/catalog

Fetches a collection of all product catalogs, 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

Query

string

ids

string[]

external_references

string[]

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

object[] · required

total

integer · int32 · required

GET/core-api/catalog

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "categoryCount": 0,
      "productCount": 0
    }
  ],
  "total": 0
}

plain

Creates and stores a new product catalog.

POST

https://api.heart.work

/core-api/catalog

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

Creates and stores a new product catalog. › Request Body

name

string · required

externalReference

string

Creates and stores a new product catalog. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

categoryCount

integer · int32 · required

productCount

integer · int32 · required

externalReference

string

POST/core-api/catalog

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

shell

Example Request Body

{
  "externalReference": "externalReference",
  "name": "name"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "categoryCount": 0,
  "productCount": 0
}

plain

Fetches a single product catalog, by id.

GET

https://api.heart.work

/core-api/catalog/{id}

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

id

string · required

Unique id of the product catalog to fetch.

Fetches a single product catalog, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

categoryCount

integer · int32 · required

productCount

integer · int32 · required

externalReference

string

GET/core-api/catalog/{id}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "categoryCount": 0,
  "productCount": 0
}

plain

Updates an existing product catalog, replacing it entirely.

PUT

https://api.heart.work

/core-api/catalog/{id}

On success, returns the updated entity in the response.

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

id

string · required

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

name

string · required

id

string · required

externalReference

string

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

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

categoryCount

integer · int32 · required

productCount

integer · int32 · required

externalReference

string

PUT/core-api/catalog/{id}

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

shell

Example Request Body

{
  "externalReference": "externalReference",
  "name": "name",
  "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",
  "categoryCount": 0,
  "productCount": 0
}

plain

Deletes an existing product catalog, by id.

DELETE

https://api.heart.work

/core-api/catalog/{id}

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

id

string · required

Unique id of the product to delete.

Deletes an existing product catalog, by id. › Responses

No data returned

DELETE/core-api/catalog/{id}

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

shell

Example Responses

No example specified for this content type

Brands Comments