Documentation
Core API Reference
Commerce API Reference
Accounts
Fetches a single account, for the current logged in user.
get
Adds an address to an account.
post
Auth
Authenticate against the API in order to receive an access token.
post
Contacts
Fetches a single contact, for the currently logged in user.
get
ContentPages
/commerce-api/cms/contentpages
get
/commerce-api/cms/contentpages/{id}
get
Currencies
/commerce-api/internationalization/currencies
get
FavouriteProducts
Fetches a collection of all product favourites, for the provided workspace
get
Creates a new product favourite
post
Deletes an existing product favourite
delete
Identities
Fetches the current client login.
get
Update the current users client login
put
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
/commerce-api/localization/languages/supported
get
PickupLocations
Fetches a collection of all PickupLocations, for the provided workspace
get
Fetches a single PickupLocation, by id.
get
ProductCategories
Fetches a hierarchy of all product categories, for the provided workspace
get
Fetches a collection of all product categories, for the provided workspace
get
Fetches a single product category, by id.
get
Fetches a single product category, by slug.
get
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
post
Fetches a single product, by id.
get
Fetches a single product, by barcode.
get
Fetches a single product, by slug.
get
Gets the total price for multiple products
post
Get product filters, this method uses a POST instead of GET because of https://github.com/heartwork/roadmap/issues/690
post
Gets the price for a product, by id
get
Gets the prices for multiple products
post
SalesOrders
Fetches a single sales order, by id.
get
/commerce-api/salesorders/order-number/{orderNumber}
get
Fetches a collection of all sales orders, filtered by the input
get
Creates and stores a new sales order.
post
Updates the status of an existing sales order
put
Adds new sales order lines to a sales order.
post
/commerce-api/salesorders/filters
get
Stocks
/commerce-api/inventory/stocks
get
Workspaces
/commerce-api/workspaces/settings
get
Schemas
powered by Zudoku
Menu
Heartwork Commerce API
Heartwork Commerce API
Currencies
Endpoint
https://api.heart.work
Download schema
GET
https://api.heart.work
/commerce-api/internationalization/currencies
Responses
text/plain
application/json
text/json
200
OK
data
object[]
·
required
total
integer
·
int32
·
required
ContentPages
FavouriteProducts
