Heartwork API

Products

Endpointhttps://api.heart.work

Download schema

Fetches all used product unique tags

GET

https://api.heart.work

/core-api/masterdata/products/tags

Fetches all used product unique tags › Responses

string[]

GET/core-api/masterdata/products/tags

curl --request GET \
  --url https://api.heart.work/core-api/masterdata/products/tags

shell

Example Responses

[
  "string"
]

plain

List products based on search/filter values, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690

POST

https://api.heart.work

/core-api/catalog/products/list

List products based on search/filter values, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Request Body

take

integer · int32 · required

skip

integer · int32 · required

sortBy

string · enum · required

Enum values:

DisplayOrder

Name

ids

string[]

catalogIds

string[]

categoryIds

string[]

skus

string[]

gtins

string[]

barcodes

string[]

slugs

string[]

type

string · enum

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

object[]

isMissingImages

boolean

isMissingDescriptions

boolean

isMissingAttributes

boolean

query

string

sortOrder

string · enum

Enum values:

Asc

Desc

List products based on search/filter values, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Responses

object[] · required

total

integer · int32 · required

POST/core-api/catalog/products/list

curl --request POST \
  --url https://api.heart.work/core-api/catalog/products/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "string"
  ],
  "catalogIds": [
    "string"
  ],
  "categoryIds": [
    "string"
  ],
  "skus": [
    "string"
  ],
  "gtins": [
    "string"
  ],
  "barcodes": [
    "string"
  ],
  "slugs": [
    "string"
  ],
  "type": "SimpleProduct",
  "productFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ],
  "isMissingImages": true,
  "isMissingDescriptions": true,
  "isMissingAttributes": true,
  "query": "query",
  "take": 0,
  "skip": 0,
  "sortOrder": "Asc",
  "sortBy": "DisplayOrder"
}
'

shell

Example Request Body

{
  "ids": [
    "string"
  ],
  "catalogIds": [
    "string"
  ],
  "categoryIds": [
    "string"
  ],
  "skus": [
    "string"
  ],
  "gtins": [
    "string"
  ],
  "barcodes": [
    "string"
  ],
  "slugs": [
    "string"
  ],
  "type": "SimpleProduct",
  "productFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ],
  "isMissingImages": true,
  "isMissingDescriptions": true,
  "isMissingAttributes": true,
  "query": "query",
  "take": 0,
  "skip": 0,
  "sortOrder": "Asc",
  "sortBy": "DisplayOrder"
}

json

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "productType": "SimpleProduct",
      "sku": "sku",
      "gtin": "gtin",
      "barcodes": [
        "string"
      ],
      "packing": {
        "packingUnit": 0,
        "packingContainer": "packingContainer",
        "packingQuantity": 0,
        "unit": "unit"
      },
      "productCode": "productCode",
      "price": {
        "salesPrice": 0,
        "purchasePrice": 0,
        "suggestedRetailPrice": 0,
        "vatCodeId": "vatCodeId",
        "shouldRequestPrice": true,
        "vatCode": {
          "id": "id",
          "workspace": "workspace",
          "createdAt": "2024-08-25T15:00:00Z",
          "modifiedAt": "2024-08-25T15:00:00Z",
          "externalReference": "externalReference",
          "name": "name",
          "code": "code",
          "percentage": 0
        }
      },
      "slug": "slug",
      "searchCode": "searchCode",
      "visibilitySettings": {
        "showInFilter": true,
        "showInSearch": true
      },
      "introducedAt": "2024-08-25T15:00:00Z",
      "categories": [
        {
          "id": "id",
          "name": "name",
          "type": "ProductCategory"
        }
      ],
      "attributes": [
        {
          "attribute": {
            "id": "id",
            "name": "name",
            "type": "ProductAttribute"
          },
          "selectedOption": {
            "label": "label",
            "value": "value"
          },
          "configurable": true
        }
      ],
      "links": [
        {
          "linkType": "Unspecified",
          "displayOrder": 0,
          "product": {
            "id": "id",
            "name": "name",
            "type": "Product"
          }
        }
      ],
      "catalogs": [
        {
          "id": "id",
          "name": "name",
          "type": "ProductCatalog"
        }
      ],
      "active": true,
      "tags": [
        "string"
      ],
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "displayOrder": 0,
      "images": [
        {
          "filename": "filename",
          "displayOrder": 0
        }
      ],
      "hyperlinks": [
        {
          "url": "url",
          "description": "description",
          "type": "Website"
        }
      ],
      "salesSettings": {
        "minimumQuantity": 0,
        "quantityStep": 0
      },
      "showStock": true,
      "brand": {
        "id": "id",
        "name": "name",
        "type": "Brand"
      },
      "manufacturer": {
        "id": "id",
        "name": "name",
        "type": "ProductManufacturer"
      },
      "issues": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "productId": "productId",
          "isIgnored": true,
          "type": "type"
        }
      ]
    }
  ],
  "total": 0
}

plain

Fetches a single product, by id.

GET

https://api.heart.work

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

Fetches a single product, by id. › path Parameters

id

string · required

Unique id of the product to fetch.

Fetches a single product, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

barcodes

string[] · required

object · required

slug

string · required

searchCode

string · required

object · required

introducedAt

string · date-time · required

object[] · required

active

boolean · required

tags

string[] · required

object[] · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object[] · required

externalReference

string

sku

string

gtin

string

productCode

string

object

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

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "productType": "SimpleProduct",
  "sku": "sku",
  "gtin": "gtin",
  "barcodes": [
    "string"
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "productCode": "productCode",
  "price": {
    "salesPrice": 0,
    "purchasePrice": 0,
    "suggestedRetailPrice": 0,
    "vatCodeId": "vatCodeId",
    "shouldRequestPrice": true,
    "vatCode": {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "code": "code",
      "percentage": 0
    }
  },
  "slug": "slug",
  "searchCode": "searchCode",
  "visibilitySettings": {
    "showInFilter": true,
    "showInSearch": true
  },
  "introducedAt": "2024-08-25T15:00:00Z",
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCategory"
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "ProductAttribute"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "Product"
      }
    }
  ],
  "catalogs": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCatalog"
    }
  ],
  "active": true,
  "tags": [
    "string"
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0,
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "showStock": true,
  "brand": {
    "id": "id",
    "name": "name",
    "type": "Brand"
  },
  "manufacturer": {
    "id": "id",
    "name": "name",
    "type": "ProductManufacturer"
  },
  "issues": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "productId": "productId",
      "isIgnored": true,
      "type": "type"
    }
  ]
}

plain

Updates an existing product, replacing it entirely.

PUT

https://api.heart.work

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

On success, returns the updated entity in the response.

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

id

string · required

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

name

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

active

boolean · required

displayOrder

integer · int32 · required

showStock

boolean · required

id

string · required

externalReference

string

sku

string

gtin

string

barcodes

string[]

object

productCode

string

object

searchCode

string

object

introducedAt

string · date-time

categories

string[]

object[]

catalogs

string[]

manufacturerId

string

tags

string[]

object[]

brandId

string

object[]

object

Updates an existing product, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

barcodes

string[] · required

object · required

slug

string · required

searchCode

string · required

object · required

introducedAt

string · date-time · required

object[] · required

active

boolean · required

tags

string[] · required

object[] · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object[] · required

externalReference

string

sku

string

gtin

string

productCode

string

object

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

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/products/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "name": "name",
  "productType": "SimpleProduct",
  "sku": "sku",
  "gtin": "gtin",
  "barcodes": [
    "string"
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "productCode": "productCode",
  "price": {
    "salesPrice": 0,
    "purchasePrice": 0,
    "suggestedRetailPrice": 0,
    "vatCodeId": "vatCodeId",
    "shouldRequestPrice": true
  },
  "searchCode": "searchCode",
  "visibilitySettings": {
    "showInFilter": true,
    "showInSearch": true
  },
  "introducedAt": "2024-08-25T15:00:00Z",
  "categories": [
    "string"
  ],
  "attributes": [
    {
      "attributeId": "attributeId",
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "productId": "productId",
      "linkType": "Unspecified",
      "displayOrder": 0
    }
  ],
  "catalogs": [
    "string"
  ],
  "manufacturerId": "manufacturerId",
  "active": true,
  "tags": [
    "string"
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "brandId": "brandId",
  "displayOrder": 0,
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "showStock": true,
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "name": "name",
  "productType": "SimpleProduct",
  "sku": "sku",
  "gtin": "gtin",
  "barcodes": [
    "string"
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "productCode": "productCode",
  "price": {
    "salesPrice": 0,
    "purchasePrice": 0,
    "suggestedRetailPrice": 0,
    "vatCodeId": "vatCodeId",
    "shouldRequestPrice": true
  },
  "searchCode": "searchCode",
  "visibilitySettings": {
    "showInFilter": true,
    "showInSearch": true
  },
  "introducedAt": "2024-08-25T15:00:00Z",
  "categories": [
    "string"
  ],
  "attributes": [
    {
      "attributeId": "attributeId",
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "productId": "productId",
      "linkType": "Unspecified",
      "displayOrder": 0
    }
  ],
  "catalogs": [
    "string"
  ],
  "manufacturerId": "manufacturerId",
  "active": true,
  "tags": [
    "string"
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "brandId": "brandId",
  "displayOrder": 0,
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "showStock": 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",
  "productType": "SimpleProduct",
  "sku": "sku",
  "gtin": "gtin",
  "barcodes": [
    "string"
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "productCode": "productCode",
  "price": {
    "salesPrice": 0,
    "purchasePrice": 0,
    "suggestedRetailPrice": 0,
    "vatCodeId": "vatCodeId",
    "shouldRequestPrice": true,
    "vatCode": {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "code": "code",
      "percentage": 0
    }
  },
  "slug": "slug",
  "searchCode": "searchCode",
  "visibilitySettings": {
    "showInFilter": true,
    "showInSearch": true
  },
  "introducedAt": "2024-08-25T15:00:00Z",
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCategory"
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "ProductAttribute"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "Product"
      }
    }
  ],
  "catalogs": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCatalog"
    }
  ],
  "active": true,
  "tags": [
    "string"
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0,
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "showStock": true,
  "brand": {
    "id": "id",
    "name": "name",
    "type": "Brand"
  },
  "manufacturer": {
    "id": "id",
    "name": "name",
    "type": "ProductManufacturer"
  },
  "issues": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "productId": "productId",
      "isIgnored": true,
      "type": "type"
    }
  ]
}

plain

Deletes an existing product, by id.

DELETE

https://api.heart.work

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

Deletes an existing product, by id. › path Parameters

id

string · required

Unique id of the product to delete.

Deletes an existing product, by id. › Responses

No data returned

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

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

shell

Example Responses

No example specified for this content type

Updates products in bulk.

PUT

https://api.heart.work

/core-api/catalog/products/bulk

Updates products in bulk. › Request Body

object[] · required

Updates products in bulk. › Responses

object[] · required

total

integer · int32 · required

PUT/core-api/catalog/products/bulk

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/products/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "updateProductRequests": [
    {
      "externalReference": "externalReference",
      "name": "name",
      "productType": "SimpleProduct",
      "sku": "sku",
      "gtin": "gtin",
      "barcodes": [
        "string"
      ],
      "packing": {
        "packingUnit": 0,
        "packingContainer": "packingContainer",
        "packingQuantity": 0,
        "unit": "unit"
      },
      "productCode": "productCode",
      "price": {
        "salesPrice": 0,
        "purchasePrice": 0,
        "suggestedRetailPrice": 0,
        "vatCodeId": "vatCodeId",
        "shouldRequestPrice": true
      },
      "searchCode": "searchCode",
      "visibilitySettings": {
        "showInFilter": true,
        "showInSearch": true
      },
      "introducedAt": "2024-08-25T15:00:00Z",
      "categories": [
        "string"
      ],
      "attributes": [
        {
          "attributeId": "attributeId",
          "selectedOption": {
            "label": "label",
            "value": "value"
          },
          "configurable": true
        }
      ],
      "links": [
        {
          "productId": "productId",
          "linkType": "Unspecified",
          "displayOrder": 0
        }
      ],
      "catalogs": [
        "string"
      ],
      "manufacturerId": "manufacturerId",
      "active": true,
      "tags": [
        "string"
      ],
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "brandId": "brandId",
      "displayOrder": 0,
      "images": [
        {
          "filename": "filename",
          "displayOrder": 0
        }
      ],
      "hyperlinks": [
        {
          "url": "url",
          "description": "description",
          "type": "Website"
        }
      ],
      "salesSettings": {
        "minimumQuantity": 0,
        "quantityStep": 0
      },
      "showStock": true,
      "id": "id"
    }
  ]
}
'

shell

Example Request Body

{
  "updateProductRequests": [
    {
      "externalReference": "externalReference",
      "name": "name",
      "productType": "SimpleProduct",
      "sku": "sku",
      "gtin": "gtin",
      "barcodes": [
        "string"
      ],
      "packing": {
        "packingUnit": 0,
        "packingContainer": "packingContainer",
        "packingQuantity": 0,
        "unit": "unit"
      },
      "productCode": "productCode",
      "price": {
        "salesPrice": 0,
        "purchasePrice": 0,
        "suggestedRetailPrice": 0,
        "vatCodeId": "vatCodeId",
        "shouldRequestPrice": true
      },
      "searchCode": "searchCode",
      "visibilitySettings": {
        "showInFilter": true,
        "showInSearch": true
      },
      "introducedAt": "2024-08-25T15:00:00Z",
      "categories": [
        "string"
      ],
      "attributes": [
        {
          "attributeId": "attributeId",
          "selectedOption": {
            "label": "label",
            "value": "value"
          },
          "configurable": true
        }
      ],
      "links": [
        {
          "productId": "productId",
          "linkType": "Unspecified",
          "displayOrder": 0
        }
      ],
      "catalogs": [
        "string"
      ],
      "manufacturerId": "manufacturerId",
      "active": true,
      "tags": [
        "string"
      ],
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "brandId": "brandId",
      "displayOrder": 0,
      "images": [
        {
          "filename": "filename",
          "displayOrder": 0
        }
      ],
      "hyperlinks": [
        {
          "url": "url",
          "description": "description",
          "type": "Website"
        }
      ],
      "salesSettings": {
        "minimumQuantity": 0,
        "quantityStep": 0
      },
      "showStock": true,
      "id": "id"
    }
  ]
}

json

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "productType": "SimpleProduct",
      "sku": "sku",
      "gtin": "gtin",
      "barcodes": [
        "string"
      ],
      "packing": {
        "packingUnit": 0,
        "packingContainer": "packingContainer",
        "packingQuantity": 0,
        "unit": "unit"
      },
      "productCode": "productCode",
      "price": {
        "salesPrice": 0,
        "purchasePrice": 0,
        "suggestedRetailPrice": 0,
        "vatCodeId": "vatCodeId",
        "shouldRequestPrice": true,
        "vatCode": {
          "id": "id",
          "workspace": "workspace",
          "createdAt": "2024-08-25T15:00:00Z",
          "modifiedAt": "2024-08-25T15:00:00Z",
          "externalReference": "externalReference",
          "name": "name",
          "code": "code",
          "percentage": 0
        }
      },
      "slug": "slug",
      "searchCode": "searchCode",
      "visibilitySettings": {
        "showInFilter": true,
        "showInSearch": true
      },
      "introducedAt": "2024-08-25T15:00:00Z",
      "categories": [
        {
          "id": "id",
          "name": "name",
          "type": "ProductCategory"
        }
      ],
      "attributes": [
        {
          "attribute": {
            "id": "id",
            "name": "name",
            "type": "ProductAttribute"
          },
          "selectedOption": {
            "label": "label",
            "value": "value"
          },
          "configurable": true
        }
      ],
      "links": [
        {
          "linkType": "Unspecified",
          "displayOrder": 0,
          "product": {
            "id": "id",
            "name": "name",
            "type": "Product"
          }
        }
      ],
      "catalogs": [
        {
          "id": "id",
          "name": "name",
          "type": "ProductCatalog"
        }
      ],
      "active": true,
      "tags": [
        "string"
      ],
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "displayOrder": 0,
      "images": [
        {
          "filename": "filename",
          "displayOrder": 0
        }
      ],
      "hyperlinks": [
        {
          "url": "url",
          "description": "description",
          "type": "Website"
        }
      ],
      "salesSettings": {
        "minimumQuantity": 0,
        "quantityStep": 0
      },
      "showStock": true,
      "brand": {
        "id": "id",
        "name": "name",
        "type": "Brand"
      },
      "manufacturer": {
        "id": "id",
        "name": "name",
        "type": "ProductManufacturer"
      },
      "issues": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "productId": "productId",
          "isIgnored": true,
          "type": "type"
        }
      ]
    }
  ],
  "total": 0
}

plain

Fetches a single product, by gtin.

GET

https://api.heart.work

/core-api/catalog/products/gtin/{gtin}

Fetches a single product, by gtin. › path Parameters

gtin

string · required

Unique gtin of the product to fetch.

Fetches a single product, by gtin. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

barcodes

string[] · required

object · required

slug

string · required

searchCode

string · required

object · required

introducedAt

string · date-time · required

object[] · required

active

boolean · required

tags

string[] · required

object[] · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object[] · required

externalReference

string

sku

string

gtin

string

productCode

string

object

GET/core-api/catalog/products/gtin/{gtin}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "productType": "SimpleProduct",
  "sku": "sku",
  "gtin": "gtin",
  "barcodes": [
    "string"
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "productCode": "productCode",
  "price": {
    "salesPrice": 0,
    "purchasePrice": 0,
    "suggestedRetailPrice": 0,
    "vatCodeId": "vatCodeId",
    "shouldRequestPrice": true,
    "vatCode": {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "code": "code",
      "percentage": 0
    }
  },
  "slug": "slug",
  "searchCode": "searchCode",
  "visibilitySettings": {
    "showInFilter": true,
    "showInSearch": true
  },
  "introducedAt": "2024-08-25T15:00:00Z",
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCategory"
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "ProductAttribute"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "Product"
      }
    }
  ],
  "catalogs": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCatalog"
    }
  ],
  "active": true,
  "tags": [
    "string"
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0,
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "showStock": true,
  "brand": {
    "id": "id",
    "name": "name",
    "type": "Brand"
  },
  "manufacturer": {
    "id": "id",
    "name": "name",
    "type": "ProductManufacturer"
  },
  "issues": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "productId": "productId",
      "isIgnored": true,
      "type": "type"
    }
  ]
}

plain

Fetches a single product, by sku.

GET

https://api.heart.work

/core-api/catalog/products/sku/{sku}

Fetches a single product, by sku. › path Parameters

sku

string · required

Unique sku of the product to fetch.

Fetches a single product, by sku. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

barcodes

string[] · required

object · required

slug

string · required

searchCode

string · required

object · required

introducedAt

string · date-time · required

object[] · required

active

boolean · required

tags

string[] · required

object[] · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object[] · required

externalReference

string

sku

string

gtin

string

productCode

string

object

GET/core-api/catalog/products/sku/{sku}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "productType": "SimpleProduct",
  "sku": "sku",
  "gtin": "gtin",
  "barcodes": [
    "string"
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "productCode": "productCode",
  "price": {
    "salesPrice": 0,
    "purchasePrice": 0,
    "suggestedRetailPrice": 0,
    "vatCodeId": "vatCodeId",
    "shouldRequestPrice": true,
    "vatCode": {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "code": "code",
      "percentage": 0
    }
  },
  "slug": "slug",
  "searchCode": "searchCode",
  "visibilitySettings": {
    "showInFilter": true,
    "showInSearch": true
  },
  "introducedAt": "2024-08-25T15:00:00Z",
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCategory"
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "ProductAttribute"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "Product"
      }
    }
  ],
  "catalogs": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCatalog"
    }
  ],
  "active": true,
  "tags": [
    "string"
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0,
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "showStock": true,
  "brand": {
    "id": "id",
    "name": "name",
    "type": "Brand"
  },
  "manufacturer": {
    "id": "id",
    "name": "name",
    "type": "ProductManufacturer"
  },
  "issues": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "productId": "productId",
      "isIgnored": true,
      "type": "type"
    }
  ]
}

plain

Fetches a single product, by barcode.

GET

https://api.heart.work

/core-api/catalog/products/barcode/{barcode}

Fetches a single product, by barcode. › path Parameters

barcode

string · required

Unique barcode of the product to fetch.

Fetches a single product, by barcode. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

barcodes

string[] · required

object · required

slug

string · required

searchCode

string · required

object · required

introducedAt

string · date-time · required

object[] · required

active

boolean · required

tags

string[] · required

object[] · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object[] · required

externalReference

string

sku

string

gtin

string

productCode

string

object

GET/core-api/catalog/products/barcode/{barcode}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "productType": "SimpleProduct",
  "sku": "sku",
  "gtin": "gtin",
  "barcodes": [
    "string"
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "productCode": "productCode",
  "price": {
    "salesPrice": 0,
    "purchasePrice": 0,
    "suggestedRetailPrice": 0,
    "vatCodeId": "vatCodeId",
    "shouldRequestPrice": true,
    "vatCode": {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "code": "code",
      "percentage": 0
    }
  },
  "slug": "slug",
  "searchCode": "searchCode",
  "visibilitySettings": {
    "showInFilter": true,
    "showInSearch": true
  },
  "introducedAt": "2024-08-25T15:00:00Z",
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCategory"
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "ProductAttribute"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "Product"
      }
    }
  ],
  "catalogs": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCatalog"
    }
  ],
  "active": true,
  "tags": [
    "string"
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0,
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "showStock": true,
  "brand": {
    "id": "id",
    "name": "name",
    "type": "Brand"
  },
  "manufacturer": {
    "id": "id",
    "name": "name",
    "type": "ProductManufacturer"
  },
  "issues": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "productId": "productId",
      "isIgnored": true,
      "type": "type"
    }
  ]
}

plain

Fetches a single product, by slug.

GET

https://api.heart.work

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

Fetches a single product, by slug. › path Parameters

slug

string · required

Unique slug of the product to fetch.

Fetches a single product, by slug. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

barcodes

string[] · required

object · required

slug

string · required

searchCode

string · required

object · required

introducedAt

string · date-time · required

object[] · required

active

boolean · required

tags

string[] · required

object[] · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object[] · required

externalReference

string

sku

string

gtin

string

productCode

string

object

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

curl --request GET \
  --url https://api.heart.work/core-api/catalog/products/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",
  "productType": "SimpleProduct",
  "sku": "sku",
  "gtin": "gtin",
  "barcodes": [
    "string"
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "productCode": "productCode",
  "price": {
    "salesPrice": 0,
    "purchasePrice": 0,
    "suggestedRetailPrice": 0,
    "vatCodeId": "vatCodeId",
    "shouldRequestPrice": true,
    "vatCode": {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "code": "code",
      "percentage": 0
    }
  },
  "slug": "slug",
  "searchCode": "searchCode",
  "visibilitySettings": {
    "showInFilter": true,
    "showInSearch": true
  },
  "introducedAt": "2024-08-25T15:00:00Z",
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCategory"
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "ProductAttribute"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "Product"
      }
    }
  ],
  "catalogs": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCatalog"
    }
  ],
  "active": true,
  "tags": [
    "string"
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0,
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "showStock": true,
  "brand": {
    "id": "id",
    "name": "name",
    "type": "Brand"
  },
  "manufacturer": {
    "id": "id",
    "name": "name",
    "type": "ProductManufacturer"
  },
  "issues": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "productId": "productId",
      "isIgnored": true,
      "type": "type"
    }
  ]
}

plain

Creates and stores a new product.

POST

https://api.heart.work

/core-api/catalog/products

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

Creates and stores a new product. › Request Body

name

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

active

boolean · required

displayOrder

integer · int32 · required

showStock

boolean · required

externalReference

string

sku

string

gtin

string

barcodes

string[]

object

productCode

string

object

searchCode

string

object

introducedAt

string · date-time

categories

string[]

object[]

catalogs

string[]

manufacturerId

string

tags

string[]

object[]

brandId

string

object[]

object

Creates and stores a new product. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

barcodes

string[] · required

object · required

slug

string · required

searchCode

string · required

object · required

introducedAt

string · date-time · required

object[] · required

active

boolean · required

tags

string[] · required

object[] · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object[] · required

externalReference

string

sku

string

gtin

string

productCode

string

object

POST/core-api/catalog/products

curl --request POST \
  --url https://api.heart.work/core-api/catalog/products \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "name": "name",
  "productType": "SimpleProduct",
  "sku": "sku",
  "gtin": "gtin",
  "barcodes": [
    "string"
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "productCode": "productCode",
  "price": {
    "salesPrice": 0,
    "purchasePrice": 0,
    "suggestedRetailPrice": 0,
    "vatCodeId": "vatCodeId",
    "shouldRequestPrice": true
  },
  "searchCode": "searchCode",
  "visibilitySettings": {
    "showInFilter": true,
    "showInSearch": true
  },
  "introducedAt": "2024-08-25T15:00:00Z",
  "categories": [
    "string"
  ],
  "attributes": [
    {
      "attributeId": "attributeId",
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "productId": "productId",
      "linkType": "Unspecified",
      "displayOrder": 0
    }
  ],
  "catalogs": [
    "string"
  ],
  "manufacturerId": "manufacturerId",
  "active": true,
  "tags": [
    "string"
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "brandId": "brandId",
  "displayOrder": 0,
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "showStock": true
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "name": "name",
  "productType": "SimpleProduct",
  "sku": "sku",
  "gtin": "gtin",
  "barcodes": [
    "string"
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "productCode": "productCode",
  "price": {
    "salesPrice": 0,
    "purchasePrice": 0,
    "suggestedRetailPrice": 0,
    "vatCodeId": "vatCodeId",
    "shouldRequestPrice": true
  },
  "searchCode": "searchCode",
  "visibilitySettings": {
    "showInFilter": true,
    "showInSearch": true
  },
  "introducedAt": "2024-08-25T15:00:00Z",
  "categories": [
    "string"
  ],
  "attributes": [
    {
      "attributeId": "attributeId",
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "productId": "productId",
      "linkType": "Unspecified",
      "displayOrder": 0
    }
  ],
  "catalogs": [
    "string"
  ],
  "manufacturerId": "manufacturerId",
  "active": true,
  "tags": [
    "string"
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "brandId": "brandId",
  "displayOrder": 0,
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "showStock": true
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "name": "name",
  "productType": "SimpleProduct",
  "sku": "sku",
  "gtin": "gtin",
  "barcodes": [
    "string"
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "productCode": "productCode",
  "price": {
    "salesPrice": 0,
    "purchasePrice": 0,
    "suggestedRetailPrice": 0,
    "vatCodeId": "vatCodeId",
    "shouldRequestPrice": true,
    "vatCode": {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "code": "code",
      "percentage": 0
    }
  },
  "slug": "slug",
  "searchCode": "searchCode",
  "visibilitySettings": {
    "showInFilter": true,
    "showInSearch": true
  },
  "introducedAt": "2024-08-25T15:00:00Z",
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCategory"
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "ProductAttribute"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "Product"
      }
    }
  ],
  "catalogs": [
    {
      "id": "id",
      "name": "name",
      "type": "ProductCatalog"
    }
  ],
  "active": true,
  "tags": [
    "string"
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "displayOrder": 0,
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "showStock": true,
  "brand": {
    "id": "id",
    "name": "name",
    "type": "Brand"
  },
  "manufacturer": {
    "id": "id",
    "name": "name",
    "type": "ProductManufacturer"
  },
  "issues": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "productId": "productId",
      "isIgnored": true,
      "type": "type"
    }
  ]
}

plain

Updates existing products with provided categories.

PUT

https://api.heart.work

/core-api/catalog/products/categories

Updates existing products with provided categories. › Request Body

productIds

string[] · required

categoryIds

string[] · required

Updates existing products with provided categories. › Responses

No data returned

PUT/core-api/catalog/products/categories

curl --request PUT \
  --url https://api.heart.work/core-api/catalog/products/categories \
  --header 'Content-Type: application/json' \
  --data '
{
  "productIds": [
    "string"
  ],
  "categoryIds": [
    "string"
  ]
}
'

shell

Example Request Body

{
  "productIds": [
    "string"
  ],
  "categoryIds": [
    "string"
  ]
}

json

Example Responses

No example specified for this content type

Removes products from provided categories.

DELETE

https://api.heart.work

/core-api/catalog/products/categories

Removes products from provided categories. › Request Body

productIds

string[] · required

categoryIds

string[] · required

Removes products from provided categories. › Responses

No data returned

DELETE/core-api/catalog/products/categories

curl --request DELETE \
  --url https://api.heart.work/core-api/catalog/products/categories \
  --header 'Content-Type: application/json' \
  --data '
{
  "productIds": [
    "string"
  ],
  "categoryIds": [
    "string"
  ]
}
'

shell

Example Request Body

{
  "productIds": [
    "string"
  ],
  "categoryIds": [
    "string"
  ]
}

json

Example Responses

No example specified for this content type

Gets the price for a product, by id

GET

https://api.heart.work

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

Gets the price for a product, by id › path Parameters

id

string · required

Unique id of the product

Gets the price for a product, by id › query Parameters

quantity

integer · int32

The quantity of the product to calculate the price for

customerId

string

Unique id of the customer

Gets the price for a product, by id › Responses

productId

string · required

sku

string · required

salesPrice

number · double · required

purchasePrice

number · double · required

suggestedRetailPrice

number · double · required

customerPrice

number · double · required

shouldRequestPrice

boolean · required

object · required

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

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

shell

Example Responses

{
  "productId": "productId",
  "sku": "sku",
  "salesPrice": 0,
  "purchasePrice": 0,
  "suggestedRetailPrice": 0,
  "customerPrice": 0,
  "shouldRequestPrice": true,
  "vatCode": {
    "id": "id",
    "workspace": "workspace",
    "createdAt": "2024-08-25T15:00:00Z",
    "modifiedAt": "2024-08-25T15:00:00Z",
    "externalReference": "externalReference",
    "name": "name",
    "code": "code",
    "percentage": 0
  }
}

plain

Gets the prices for multiple products

GET

https://api.heart.work

/core-api/catalog/products/prices

Gets the prices for multiple products › query Parameters

object[]

The products and their quantities

customerId

string

Unique id of the customer

Gets the prices for multiple products › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/products/prices

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

shell

Example Responses

{
  "data": [
    {
      "productId": "productId",
      "sku": "sku",
      "salesPrice": 0,
      "purchasePrice": 0,
      "suggestedRetailPrice": 0,
      "customerPrice": 0,
      "shouldRequestPrice": true,
      "vatCode": {
        "id": "id",
        "workspace": "workspace",
        "createdAt": "2024-08-25T15:00:00Z",
        "modifiedAt": "2024-08-25T15:00:00Z",
        "externalReference": "externalReference",
        "name": "name",
        "code": "code",
        "percentage": 0
      }
    }
  ],
  "total": 0
}

plain

Gets the total price for multiple products

GET

https://api.heart.work

/core-api/catalog/products/price/total

Gets the total price for multiple products › query Parameters

object[]

The products and their quantities

customerId

string

Unique id of the customer

Gets the total price for multiple products › Responses

object

GET/core-api/catalog/products/price/total

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

shell

Example Responses

{
  "totals": {
    "totalSalesPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    },
    "totalPurchasePrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    },
    "totalSuggestedRetailPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    },
    "totalCustomerPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    }
  }
}

plain

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

POST

https://api.heart.work

/core-api/catalog/products/images

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

images

string[]

The images to upload

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

fileUris

string[] · required

POST/core-api/catalog/products/images

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

ProductManufacturers Reports