Heartwork API

ProductAttributes

Endpointhttps://api.heart.work

Download schema

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

GET

https://api.heart.work

/core-api/catalog/products/attributes

Fetches a collection of all product attributes, 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 attributes, for the provided workspace › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/products/attributes

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "categoryIds": [
        "string"
      ],
      "productCount": 0,
      "options": [
        {
          "label": "label",
          "value": "value",
          "count": 0,
          "displayOrder": 0
        }
      ]
    }
  ],
  "total": 0
}

plain

Creates and stores a new product attribute.

POST

https://api.heart.work

/core-api/catalog/products/attributes

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

Creates and stores a new product attribute. › Request Body

name

string · required

externalReference

string

Creates and stores a new product attribute. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

categoryIds

string[] · required

productCount

integer · int32 · required

object[] · required

externalReference

string

POST/core-api/catalog/products/attributes

curl --request POST \
  --url https://api.heart.work/core-api/catalog/products/attributes \
  --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",
  "categoryIds": [
    "string"
  ],
  "productCount": 0,
  "options": [
    {
      "label": "label",
      "value": "value",
      "count": 0,
      "displayOrder": 0
    }
  ]
}

plain

Fetches a single product attribute, by id.

GET

https://api.heart.work

/core-api/catalog/products/attributes/{id}

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

id

string · required

Unique id of the product attribute to fetch.

Fetches a single product attribute, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

categoryIds

string[] · required

productCount

integer · int32 · required

object[] · required

externalReference

string

GET/core-api/catalog/products/attributes/{id}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "categoryIds": [
    "string"
  ],
  "productCount": 0,
  "options": [
    {
      "label": "label",
      "value": "value",
      "count": 0,
      "displayOrder": 0
    }
  ]
}

plain

Updates an existing product attribute, replacing it entirely.

PUT

https://api.heart.work

/core-api/catalog/products/attributes/{id}

On success, returns the updated entity in the response.

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

id

string · required

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

name

string · required

id

string · required

externalReference

string

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

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

categoryIds

string[] · required

productCount

integer · int32 · required

object[] · required

externalReference

string

PUT/core-api/catalog/products/attributes/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/products/attributes/: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",
  "categoryIds": [
    "string"
  ],
  "productCount": 0,
  "options": [
    {
      "label": "label",
      "value": "value",
      "count": 0,
      "displayOrder": 0
    }
  ]
}

plain

Deletes an existing product attribute, by id.

DELETE

https://api.heart.work

/core-api/catalog/products/attributes/{id}

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

id

string · required

Unique id of the product attribute to delete.

Deletes an existing product attribute, by id. › Responses

No data returned

DELETE/core-api/catalog/products/attributes/{id}

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

shell

Example Responses

No example specified for this content type

Pipelines ProductCategories

Heartwork API

ProductAttributes

Endpointhttps://api.heart.work

Download schema

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

GET

https://api.heart.work

/core-api/catalog/products/attributes

Fetches a collection of all product attributes, 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 attributes, for the provided workspace › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/products/attributes

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "categoryIds": [
        "string"
      ],
      "productCount": 0,
      "options": [
        {
          "label": "label",
          "value": "value",
          "count": 0,
          "displayOrder": 0
        }
      ]
    }
  ],
  "total": 0
}

plain

Creates and stores a new product attribute.

POST

https://api.heart.work

/core-api/catalog/products/attributes

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

Creates and stores a new product attribute. › Request Body

name

string · required

externalReference

string

Creates and stores a new product attribute. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

categoryIds

string[] · required

productCount

integer · int32 · required

object[] · required

externalReference

string

POST/core-api/catalog/products/attributes

curl --request POST \
  --url https://api.heart.work/core-api/catalog/products/attributes \
  --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",
  "categoryIds": [
    "string"
  ],
  "productCount": 0,
  "options": [
    {
      "label": "label",
      "value": "value",
      "count": 0,
      "displayOrder": 0
    }
  ]
}

plain

Fetches a single product attribute, by id.

GET

https://api.heart.work

/core-api/catalog/products/attributes/{id}

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

id

string · required

Unique id of the product attribute to fetch.

Fetches a single product attribute, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

categoryIds

string[] · required

productCount

integer · int32 · required

object[] · required

externalReference

string

GET/core-api/catalog/products/attributes/{id}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "categoryIds": [
    "string"
  ],
  "productCount": 0,
  "options": [
    {
      "label": "label",
      "value": "value",
      "count": 0,
      "displayOrder": 0
    }
  ]
}

plain

Updates an existing product attribute, replacing it entirely.

PUT

https://api.heart.work

/core-api/catalog/products/attributes/{id}

On success, returns the updated entity in the response.

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

id

string · required

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

name

string · required

id

string · required

externalReference

string

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

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

categoryIds

string[] · required

productCount

integer · int32 · required

object[] · required

externalReference

string

PUT/core-api/catalog/products/attributes/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/products/attributes/: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",
  "categoryIds": [
    "string"
  ],
  "productCount": 0,
  "options": [
    {
      "label": "label",
      "value": "value",
      "count": 0,
      "displayOrder": 0
    }
  ]
}

plain

Deletes an existing product attribute, by id.

DELETE

https://api.heart.work

/core-api/catalog/products/attributes/{id}

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

id

string · required

Unique id of the product attribute to delete.

Deletes an existing product attribute, by id. › Responses

No data returned

DELETE/core-api/catalog/products/attributes/{id}

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

shell

Example Responses

No example specified for this content type

Pipelines ProductCategories