Heartwork Commerce API

Products

Endpointhttps://api.heart.work

Download schema

get products based on the input criteria, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690

POST

https://api.heart.work

/commerce-api/catalog/products

get products based on the input criteria, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Request Body

take

integer · int32 · required

For paged querying, the amount of records to take (defaults to 100)

skip

integer · int32 · required

For paged querying, the amount of records to skip (defaults to 0)

ids

string[]

categoryIds

string[]

For filtering data, filters on the exact value in the categories array

type

string · enum

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

object[]

query

string

For searching, the query used when searching

sortOrder

string · enum

Enum values:

Asc

Desc

sortBy

string

For sorting data, the name of the property used to sort by

get products based on the input criteria, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Responses

200

object[] · required

total

integer · int32 · required

POST/commerce-api/catalog/products

curl --request POST \
  --url https://api.heart.work/commerce-api/catalog/products \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "string"
  ],
  "categoryIds": [
    "string"
  ],
  "type": "SimpleProduct",
  "productFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ],
  "query": "query",
  "take": 0,
  "skip": 0,
  "sortOrder": "Asc",
  "sortBy": "sortBy"
}
'

shell

Example Request Body

{
  "ids": [
    "string"
  ],
  "categoryIds": [
    "string"
  ],
  "type": "SimpleProduct",
  "productFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ],
  "query": "query",
  "take": 0,
  "skip": 0,
  "sortOrder": "Asc",
  "sortBy": "sortBy"
}

json

Example Responses

{
  "data": [
    {
      "id": "id",
      "name": "name",
      "slug": "slug",
      "productType": "SimpleProduct",
      "images": [
        {
          "filename": "filename",
          "displayOrder": 0
        }
      ],
      "attributes": [
        {
          "attribute": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "selectedOption": {
            "label": "label",
            "value": "value"
          },
          "configurable": true
        }
      ],
      "links": [
        {
          "linkType": "Unspecified",
          "displayOrder": 0,
          "product": {
            "id": "id",
            "name": "name",
            "type": "type"
          }
        }
      ],
      "categories": [
        {
          "id": "id",
          "name": "name",
          "type": "type"
        }
      ],
      "packing": {
        "packingUnit": 0,
        "packingContainer": "packingContainer",
        "packingQuantity": 0,
        "unit": "unit"
      },
      "displayOrder": 0,
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "hyperlinks": [
        {
          "url": "url",
          "description": "description",
          "type": "Website"
        }
      ],
      "showStock": true,
      "salesSettings": {
        "minimumQuantity": 0,
        "quantityStep": 0
      },
      "sku": "sku",
      "gtin": "gtin",
      "brand": {
        "id": "id",
        "name": "name",
        "imageUrl": "imageUrl"
      },
      "content": {
        "seoMeta": {
          "title": "title",
          "keywords": "keywords",
          "description": "description"
        },
        "description": "description",
        "language": "language"
      }
    }
  ],
  "total": 0
}

plain

Fetches a single product, by id.

GET

https://api.heart.work

/commerce-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

name

string · required

slug

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

object[] · required

object · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object

sku

string

gtin

string

object

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

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

shell

Example Responses

{
  "id": "id",
  "name": "name",
  "slug": "slug",
  "productType": "SimpleProduct",
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "type"
      }
    }
  ],
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "type"
    }
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "displayOrder": 0,
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "showStock": true,
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "sku": "sku",
  "gtin": "gtin",
  "brand": {
    "id": "id",
    "name": "name",
    "imageUrl": "imageUrl"
  },
  "content": {
    "seoMeta": {
      "title": "title",
      "keywords": "keywords",
      "description": "description"
    },
    "description": "description",
    "language": "language"
  }
}

plain

Fetches a single product, by barcode.

GET

https://api.heart.work

/commerce-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

name

string · required

slug

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

object[] · required

object · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object

sku

string

gtin

string

object

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

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

shell

Example Responses

{
  "id": "id",
  "name": "name",
  "slug": "slug",
  "productType": "SimpleProduct",
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "type"
      }
    }
  ],
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "type"
    }
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "displayOrder": 0,
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "showStock": true,
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "sku": "sku",
  "gtin": "gtin",
  "brand": {
    "id": "id",
    "name": "name",
    "imageUrl": "imageUrl"
  },
  "content": {
    "seoMeta": {
      "title": "title",
      "keywords": "keywords",
      "description": "description"
    },
    "description": "description",
    "language": "language"
  }
}

plain

Fetches a single product, by slug.

GET

https://api.heart.work

/commerce-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

name

string · required

slug

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

object[] · required

object · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object

sku

string

gtin

string

object

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

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/products/slug/:slug

shell

Example Responses

{
  "id": "id",
  "name": "name",
  "slug": "slug",
  "productType": "SimpleProduct",
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "type"
      }
    }
  ],
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "type"
    }
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "displayOrder": 0,
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "showStock": true,
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "sku": "sku",
  "gtin": "gtin",
  "brand": {
    "id": "id",
    "name": "name",
    "imageUrl": "imageUrl"
  },
  "content": {
    "seoMeta": {
      "title": "title",
      "keywords": "keywords",
      "description": "description"
    },
    "description": "description",
    "language": "language"
  }
}

plain

Gets the total price for multiple products

POST

https://api.heart.work

/commerce-api/catalog/products/price/total

Gets the total price for multiple products › Request Body

object[]

identifier

string · required

quantity

number · double · required

Gets the total price for multiple products › Responses

object

POST/commerce-api/catalog/products/price/total

curl --request POST \
  --url https://api.heart.work/commerce-api/catalog/products/price/total \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "identifier": "identifier",
    "quantity": 0
  }
]
'

shell

Example Request Body

[
  {
    "identifier": "identifier",
    "quantity": 0
  }
]

json

Example Responses

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

plain

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690

POST

https://api.heart.work

/commerce-api/catalog/products/filters/{categoryId}

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › path Parameters

categoryId

string · required

The id of the category to get the filters from

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Request Body

query

string

catalogId

string

categoryId

string

isActive

boolean

object[]

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Responses

200

object[] · required

POST/commerce-api/catalog/products/filters/{categoryId}

curl --request POST \
  --url https://api.heart.work/commerce-api/catalog/products/filters/:categoryId \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "query",
  "catalogId": "catalogId",
  "categoryId": "categoryId",
  "isActive": true,
  "activeFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "query": "query",
  "catalogId": "catalogId",
  "categoryId": "categoryId",
  "isActive": true,
  "activeFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ]
}

json

Example Responses

{
  "filters": [
    {
      "attributeId": "attributeId",
      "attributeName": "attributeName",
      "categoryId": "categoryId",
      "displayOrder": 0,
      "isActive": true,
      "options": [
        {
          "label": "label",
          "value": "value",
          "count": 0,
          "displayOrder": 0,
          "isActive": true
        }
      ]
    }
  ]
}

plain

Gets the price for a product, by id

GET

https://api.heart.work

/commerce-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

number · double

The quantity of the product to calculate the price for

Default: 1

Gets the price for a product, by id › Responses

productId

string · required

shouldRequestPrice

boolean · required

object[] · required

A list of messages to display to the user as additional information. Can only be set in Rules.

salesPrice

number · double

suggestedRetailPrice

number · double

customerPrice

number · double

object

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

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

shell

Example Responses

{
  "productId": "productId",
  "salesPrice": 0,
  "suggestedRetailPrice": 0,
  "customerPrice": 0,
  "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
  },
  "shouldRequestPrice": true,
  "messages": [
    {
      "shortMessage": "shortMessage",
      "longMessage": "longMessage",
      "severity": "Success"
    }
  ]
}

plain

Gets the prices for multiple products

POST

https://api.heart.work

/commerce-api/catalog/products/prices

Gets the prices for multiple products › Request Body

object[]

identifier

string · required

quantity

number · double · required

Gets the prices for multiple products › Responses

200

object[]

productId

string · required

shouldRequestPrice

boolean · required

object[] · required

A list of messages to display to the user as additional information. Can only be set in Rules.

salesPrice

number · double

suggestedRetailPrice

number · double

customerPrice

number · double

object

POST/commerce-api/catalog/products/prices

curl --request POST \
  --url https://api.heart.work/commerce-api/catalog/products/prices \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "identifier": "identifier",
    "quantity": 0
  }
]
'

shell

Example Request Body

[
  {
    "identifier": "identifier",
    "quantity": 0
  }
]

json

Example Responses

[
  {
    "productId": "productId",
    "salesPrice": 0,
    "suggestedRetailPrice": 0,
    "customerPrice": 0,
    "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
    },
    "shouldRequestPrice": true,
    "messages": [
      {
        "shortMessage": "shortMessage",
        "longMessage": "longMessage",
        "severity": "Success"
      }
    ]
  }
]

plain

ProductCategories SalesOrders

Heartwork Commerce API

Products

Endpointhttps://api.heart.work

Download schema

get products based on the input criteria, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690

POST

https://api.heart.work

/commerce-api/catalog/products

get products based on the input criteria, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Request Body

take

integer · int32 · required

For paged querying, the amount of records to take (defaults to 100)

skip

integer · int32 · required

For paged querying, the amount of records to skip (defaults to 0)

ids

string[]

categoryIds

string[]

For filtering data, filters on the exact value in the categories array

type

string · enum

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

object[]

query

string

For searching, the query used when searching

sortOrder

string · enum

Enum values:

Asc

Desc

sortBy

string

For sorting data, the name of the property used to sort by

get products based on the input criteria, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Responses

200

object[] · required

total

integer · int32 · required

POST/commerce-api/catalog/products

curl --request POST \
  --url https://api.heart.work/commerce-api/catalog/products \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "string"
  ],
  "categoryIds": [
    "string"
  ],
  "type": "SimpleProduct",
  "productFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ],
  "query": "query",
  "take": 0,
  "skip": 0,
  "sortOrder": "Asc",
  "sortBy": "sortBy"
}
'

shell

Example Request Body

{
  "ids": [
    "string"
  ],
  "categoryIds": [
    "string"
  ],
  "type": "SimpleProduct",
  "productFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ],
  "query": "query",
  "take": 0,
  "skip": 0,
  "sortOrder": "Asc",
  "sortBy": "sortBy"
}

json

Example Responses

{
  "data": [
    {
      "id": "id",
      "name": "name",
      "slug": "slug",
      "productType": "SimpleProduct",
      "images": [
        {
          "filename": "filename",
          "displayOrder": 0
        }
      ],
      "attributes": [
        {
          "attribute": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "selectedOption": {
            "label": "label",
            "value": "value"
          },
          "configurable": true
        }
      ],
      "links": [
        {
          "linkType": "Unspecified",
          "displayOrder": 0,
          "product": {
            "id": "id",
            "name": "name",
            "type": "type"
          }
        }
      ],
      "categories": [
        {
          "id": "id",
          "name": "name",
          "type": "type"
        }
      ],
      "packing": {
        "packingUnit": 0,
        "packingContainer": "packingContainer",
        "packingQuantity": 0,
        "unit": "unit"
      },
      "displayOrder": 0,
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "hyperlinks": [
        {
          "url": "url",
          "description": "description",
          "type": "Website"
        }
      ],
      "showStock": true,
      "salesSettings": {
        "minimumQuantity": 0,
        "quantityStep": 0
      },
      "sku": "sku",
      "gtin": "gtin",
      "brand": {
        "id": "id",
        "name": "name",
        "imageUrl": "imageUrl"
      },
      "content": {
        "seoMeta": {
          "title": "title",
          "keywords": "keywords",
          "description": "description"
        },
        "description": "description",
        "language": "language"
      }
    }
  ],
  "total": 0
}

plain

Fetches a single product, by id.

GET

https://api.heart.work

/commerce-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

name

string · required

slug

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

object[] · required

object · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object

sku

string

gtin

string

object

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

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

shell

Example Responses

{
  "id": "id",
  "name": "name",
  "slug": "slug",
  "productType": "SimpleProduct",
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "type"
      }
    }
  ],
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "type"
    }
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "displayOrder": 0,
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "showStock": true,
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "sku": "sku",
  "gtin": "gtin",
  "brand": {
    "id": "id",
    "name": "name",
    "imageUrl": "imageUrl"
  },
  "content": {
    "seoMeta": {
      "title": "title",
      "keywords": "keywords",
      "description": "description"
    },
    "description": "description",
    "language": "language"
  }
}

plain

Fetches a single product, by barcode.

GET

https://api.heart.work

/commerce-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

name

string · required

slug

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

object[] · required

object · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object

sku

string

gtin

string

object

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

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

shell

Example Responses

{
  "id": "id",
  "name": "name",
  "slug": "slug",
  "productType": "SimpleProduct",
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "type"
      }
    }
  ],
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "type"
    }
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "displayOrder": 0,
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "showStock": true,
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "sku": "sku",
  "gtin": "gtin",
  "brand": {
    "id": "id",
    "name": "name",
    "imageUrl": "imageUrl"
  },
  "content": {
    "seoMeta": {
      "title": "title",
      "keywords": "keywords",
      "description": "description"
    },
    "description": "description",
    "language": "language"
  }
}

plain

Fetches a single product, by slug.

GET

https://api.heart.work

/commerce-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

name

string · required

slug

string · required

productType

string · enum · required

Enum values:

SimpleProduct

ConfigurableProduct

GroupedProduct

BundledProduct

object[] · required

object · required

displayOrder

integer · int32 · required

object[] · required

showStock

boolean · required

object

sku

string

gtin

string

object

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

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/products/slug/:slug

shell

Example Responses

{
  "id": "id",
  "name": "name",
  "slug": "slug",
  "productType": "SimpleProduct",
  "images": [
    {
      "filename": "filename",
      "displayOrder": 0
    }
  ],
  "attributes": [
    {
      "attribute": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "selectedOption": {
        "label": "label",
        "value": "value"
      },
      "configurable": true
    }
  ],
  "links": [
    {
      "linkType": "Unspecified",
      "displayOrder": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "type"
      }
    }
  ],
  "categories": [
    {
      "id": "id",
      "name": "name",
      "type": "type"
    }
  ],
  "packing": {
    "packingUnit": 0,
    "packingContainer": "packingContainer",
    "packingQuantity": 0,
    "unit": "unit"
  },
  "displayOrder": 0,
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "hyperlinks": [
    {
      "url": "url",
      "description": "description",
      "type": "Website"
    }
  ],
  "showStock": true,
  "salesSettings": {
    "minimumQuantity": 0,
    "quantityStep": 0
  },
  "sku": "sku",
  "gtin": "gtin",
  "brand": {
    "id": "id",
    "name": "name",
    "imageUrl": "imageUrl"
  },
  "content": {
    "seoMeta": {
      "title": "title",
      "keywords": "keywords",
      "description": "description"
    },
    "description": "description",
    "language": "language"
  }
}

plain

Gets the total price for multiple products

POST

https://api.heart.work

/commerce-api/catalog/products/price/total

Gets the total price for multiple products › Request Body

object[]

identifier

string · required

quantity

number · double · required

Gets the total price for multiple products › Responses

object

POST/commerce-api/catalog/products/price/total

curl --request POST \
  --url https://api.heart.work/commerce-api/catalog/products/price/total \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "identifier": "identifier",
    "quantity": 0
  }
]
'

shell

Example Request Body

[
  {
    "identifier": "identifier",
    "quantity": 0
  }
]

json

Example Responses

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

plain

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690

POST

https://api.heart.work

/commerce-api/catalog/products/filters/{categoryId}

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › path Parameters

categoryId

string · required

The id of the category to get the filters from

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Request Body

query

string

catalogId

string

categoryId

string

isActive

boolean

object[]

Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690 › Responses

200

object[] · required

POST/commerce-api/catalog/products/filters/{categoryId}

curl --request POST \
  --url https://api.heart.work/commerce-api/catalog/products/filters/:categoryId \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "query",
  "catalogId": "catalogId",
  "categoryId": "categoryId",
  "isActive": true,
  "activeFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ]
}
'

shell

Example Request Body

{
  "query": "query",
  "catalogId": "catalogId",
  "categoryId": "categoryId",
  "isActive": true,
  "activeFilters": [
    {
      "attributeId": "attributeId",
      "selectedOptionValues": [
        "string"
      ]
    }
  ]
}

json

Example Responses

{
  "filters": [
    {
      "attributeId": "attributeId",
      "attributeName": "attributeName",
      "categoryId": "categoryId",
      "displayOrder": 0,
      "isActive": true,
      "options": [
        {
          "label": "label",
          "value": "value",
          "count": 0,
          "displayOrder": 0,
          "isActive": true
        }
      ]
    }
  ]
}

plain

Gets the price for a product, by id

GET

https://api.heart.work

/commerce-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

number · double

The quantity of the product to calculate the price for

Default: 1

Gets the price for a product, by id › Responses

productId

string · required

shouldRequestPrice

boolean · required

object[] · required

A list of messages to display to the user as additional information. Can only be set in Rules.

salesPrice

number · double

suggestedRetailPrice

number · double

customerPrice

number · double

object

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

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

shell

Example Responses

{
  "productId": "productId",
  "salesPrice": 0,
  "suggestedRetailPrice": 0,
  "customerPrice": 0,
  "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
  },
  "shouldRequestPrice": true,
  "messages": [
    {
      "shortMessage": "shortMessage",
      "longMessage": "longMessage",
      "severity": "Success"
    }
  ]
}

plain

Gets the prices for multiple products

POST

https://api.heart.work

/commerce-api/catalog/products/prices

Gets the prices for multiple products › Request Body

object[]

identifier

string · required

quantity

number · double · required

Gets the prices for multiple products › Responses

200

object[]

productId

string · required

shouldRequestPrice

boolean · required

object[] · required

A list of messages to display to the user as additional information. Can only be set in Rules.

salesPrice

number · double

suggestedRetailPrice

number · double

customerPrice

number · double

object

POST/commerce-api/catalog/products/prices

curl --request POST \
  --url https://api.heart.work/commerce-api/catalog/products/prices \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "identifier": "identifier",
    "quantity": 0
  }
]
'

shell

Example Request Body

[
  {
    "identifier": "identifier",
    "quantity": 0
  }
]

json

Example Responses

[
  {
    "productId": "productId",
    "salesPrice": 0,
    "suggestedRetailPrice": 0,
    "customerPrice": 0,
    "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
    },
    "shouldRequestPrice": true,
    "messages": [
      {
        "shortMessage": "shortMessage",
        "longMessage": "longMessage",
        "severity": "Success"
      }
    ]
  }
]

plain

ProductCategories SalesOrders