Documentation
Core API Reference
Commerce API Reference
Accounts
Fetches a single account, by id.
get
Updates an existing account, replacing it entirely.
put
Deletes an existing account, by id.
delete
Searches accounts based on specific property values.
get
Creates and stores a new account.
post
Fetches a collection of suggested accounts, by query
get
Fetches all the details of an suggested account, by COC number and subdossier number
get
Get all filterable values for accounts
get
/core-api/accounts/stats
get
Fetches all used account unique tags
get
Fetches all used account unique industries
get
Activities
Fetches a filtered collection of heartwork activities, for the provided workspace.
get
An exception to the normal List method for when the url becomes too long
post
ActivityStatistics
/core-api/statistics/activity
get
/core-api/statistics/activity/timeline
get
Analytics
Fetches the deal periods, for the provided workspace
get
Fetches the full export, for the provided workspace
get
Apps
Fetches a collection of all apps, for the provided workspace and this user
get
AtomicScripts
/core-api/atomicscripts
get
/core-api/atomicscripts
post
/core-api/atomicscripts/{id}
get
/core-api/atomicscripts/{id}
put
/core-api/atomicscripts/{id}
delete
Auth
Authenticate against the API in order to receive an access token.
post
/core-api/auth/logout/{accessToken}
get
Brands
Fetches a collection of brands, optionally filtered by search criteria.
get
Creates and stores a new brand.
post
Fetches a single brand, by id.
get
Updates an existing brand, replacing it entirely.
put
Deletes an existing brand, by id.
delete
Upload file to the cdn for brands, images have to be added to the brands afterwards
post
Catalogs
Fetches a collection of all product catalogs, for the provided workspace
get
Creates and stores a new product catalog.
post
Fetches a single product catalog, by id.
get
Updates an existing product catalog, replacing it entirely.
put
Deletes an existing product catalog, by id.
delete
Comments
Gets comments based on specific property values.
get
Creates and stores a new comment.
post
Updates an existing comment, replacing it entirely.
put
Deletes an existing comment, by id.
delete
Contacts
Fetches a single contact, by id.
get
Updates an existing contact, replacing it entirely.
put
Deletes an existing contact, by id.
delete
Searches contacts based on specific property values.
get
Creates and stores a new contact.
post
Get all filterable values for contacts
get
Fetches all used contact unique tags
get
Fetches all used contact unique jobtitles
get
ContentPages
/core-api/cms/contentpages
get
/core-api/cms/contentpages
post
/core-api/cms/contentpages/{id}
get
/core-api/cms/contentpages/{id}
put
/core-api/cms/contentpages/{id}
delete
Currencies
/core-api/internationalization/currencies
get
/core-api/internationalization/currencies
post
/core-api/internationalization/currencies/available
get
/core-api/internationalization/currencies/{id}
put
Deals
Fetches a collection of deals, for the provided workspace based on optional filters
get
Creates and stores a new deal.
post
Fetches a single deal, by id.
get
Updates an existing deal, replacing it entirely.
put
Deletes an existing deal, by id.
delete
Get all filterable values for deals
get
Archive an existing deal, by id.
put
Restore an existing deal, by id.
put
Fetches all used deals unique statuses
get
Fetches all used contact unique tags
get
DealStatistics
/core-api/statistics/deals
get
Documents
/core-api/documents/structure
get
/core-api/documents
get
/core-api/documents
post
/core-api/documents
delete
/core-api/documents/directories
post
/core-api/documents/directories
delete
FavouriteProducts
Fetches a collection of all product favourites, for the provided workspace
get
Creates a new product favourite
post
/core-api/catalog/favouriteproducts/bulk
post
Deletes an existing product favourite
delete
Identities
Searches client logins based on specific property values.
get
Creates and stores a new client login.
post
Fetches a single client login, by id.
get
Updates an existing client login, replacing it entirely.
put
Deletes an existing client login, by id.
delete
Check if an email is available in the current workspace.
get
Check if a username is available in the current workspace.
get
Fetches a single client login, by external id.
get
Info
Returns the current API version.
get
Returns the current API version incl. the timestamp of the server, on its current timezone settings.
get
Languages
/core-api/internationalization/languages/available
get
/core-api/internationalization/languages/supported
get
/core-api/internationalization/languages/supported
post
/core-api/internationalization/languages/supported
delete
Locations
Fetches a collection of all locations, for the provided workspace
get
Creates and stores a new location.
post
Fetches a single location, by id.
get
Updates an existing location, replacing it entirely.
put
Deletes an existing location, by id.
delete
Upload file to the cdn for locations, images have to be added to the locations afterwards
post
Pipelines
Fetches a single Pipeline, by id.
get
Updates an existing Pipeline, replacing it entirely.
put
Deletes an existing Pipeline, by id.
delete
Searches Pipelines based on specific property values.
get
Creates and stores a new Pipeline.
post
/core-api/pipelines/{id}/statistics
get
ProductAttributes
Fetches a collection of all product attributes, for the provided workspace
get
Creates and stores a new product attribute.
post
Fetches a single product attribute, by id.
get
Updates an existing product attribute, replacing it entirely.
put
Deletes an existing product attribute, by id.
delete
ProductCategories
Fetches a collection of all product categories, for the provided workspace
get
Creates and stores a new product category.
post
Fetches a hierarchy of all product categories, for the provided workspace
get
Fetches a single product category, by id.
get
Updates an existing product category, replacing it entirely.
put
Deletes an existing product category, by id.
delete
Fetches a single product category, by slug.
get
Upload file to the cdn for product categories, images have to be added to the product categories afterwards
post
ProductCategoryDisplayContent
Fetches a single product display content, by id.
get
Updates an existing product display content, replacing it entirely.
put
Deletes an existing product display content, by id.
delete
Fetches a list of product display contents.
get
Creates and stores a new product display content.
post
ProductDisplayContents
Fetches a single product display content, by id.
get
Updates an existing product display content, replacing it entirely.
put
Deletes an existing product display content, by id.
delete
Fetches a list of product display contents.
get
Creates and stores a new product display content.
post
/core-api/catalog/products/content/translate/missing
post
ProductFilters
Updates a collection of product filters
put
Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690
post
ProductIssues
Fetches a collection of all product issues
get
Update a product issue for ignored values
put
Fetches product issue statistics for provided categories
get
ProductManufacturers
Fetches a collection of product manufacturers, optionally filtered by search criteria.
get
Creates and stores a new product manufacturer.
post
Fetches a single product manufacturer, by id.
get
Updates an existing product manufacturer, replacing it entirely.
put
Deletes an existing product manufacturer, by id.
delete
Products
Fetches all used product unique tags
get
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
Fetches a single product, by id.
get
Updates an existing product, replacing it entirely.
put
Deletes an existing product, by id.
delete
Updates products in bulk.
put
Fetches a single product, by gtin.
get
Fetches a single product, by sku.
get
Fetches a single product, by barcode.
get
Fetches a single product, by slug.
get
Creates and stores a new product.
post
Updates existing products with provided categories.
put
Removes products from provided categories.
delete
Gets the price for a product, by id
get
Gets the prices for multiple products
get
Gets the total price for multiple products
get
Upload file to the cdn for products, images have to be added to the products afterwards
post
Reports
Fetches the export of all deals as .xlsx file, for the provided workspace
get
Exports the hierarchy of all product categories as .xlsx file, for the provided workspace
get
SalesOrders
Fetches a collection of all sales orders, for the provided workspace
get
Creates and stores a new sales order.
post
Fetches a single sales order, by id.
get
Updates an existing sales order, replacing it entirely.
put
Deletes an existing sales order, by id.
delete
/core-api/salesorders/{id}/lines
post
Deletes an existing sales order line, by id.
delete
/core-api/salesorders/stats/daily
get
SalesOrderStatistics
/core-api/statistics/salesorders
get
Stocks
Fetches a collection of all stocks, for the provided workspace
get
Creates and stores a new stock.
post
Updates an existing stock, replacing it entirely.
put
Deletes an existing stock, by id.
delete
Tags
/core-api/masterdata/tags
get
Translations
/core-api/ai/translations
post
Users
Filters the users based on optional filters
get
Creates and stores a new user.
post
Fetches a single user, by id.
get
Updates an existing user, replacing it entirely.
put
Deletes an existing user, by id.
delete
VatCodes
Fetches a collection of all vat codes
get
Webhooks
Fetches a collection of webhooks.
get
/core-api/webhooks
post
/core-api/webhooks/{id}
get
/core-api/webhooks/{id}
put
/core-api/webhooks/{id}
delete
/core-api/webhooks/topics
get
Workspaces
Fetches a list of all workspaces, for the current user.
get
/core-api/workspaces
put
/core-api/workspaces
post
/core-api/workspaces
delete
Upload file to the cdn for workspaces, images have to be added to the appropriate place afterward.
post
Schemas
powered by Zudoku
Menu
Heartwork API
Heartwork API
Languages
Endpoint
https://api.heart.work
Download schema
GET
https://api.heart.work
/core-api/internationalization/languages/available
Responses
200
401
403
text/plain
application/json
text/json
OK
data
object[]
 ·Â
required
total
integer
 ·Â
int32
 ·Â
required
GET
https://api.heart.work
/core-api/internationalization/languages/supported
Responses
200
401
403
text/plain
application/json
text/json
OK
data
object[]
 ·Â
required
total
integer
 ·Â
int32
 ·Â
required
POST
https://api.heart.work
/core-api/internationalization/languages/supported
Request Body
languageCode
string
 ·Â
required
Responses
200
401
403
text/plain
application/json
text/json
OK
DELETE
https://api.heart.work
/core-api/internationalization/languages/supported
Request Body
languageCode
string
 ·Â
required
Responses
200
401
403
OK
No data returned
Info
Locations
