Heartwork Commerce API
string · requirednumber · double · requiredboolean · requiredboolean · requiredboolean · requiredboolean · requiredboolean · requiredstringstringstring · enum · requiredboolean · requiredstring · requiredstring · requiredstring · requiredstring · requiredstring · requiredstring[] · requiredboolean · requiredboolean · requiredboolean · requiredstring · requiredstring · enum · requiredboolean · requiredboolean · requiredstring · requiredboolean · requiredinteger · int32 · requiredboolean · requiredboolean · requiredboolean · requiredboolean · requiredboolean · requiredboolean · requiredboolean · requiredstring · enum · requiredboolean · requiredboolean · requiredboolean · requiredboolean · requiredstring · requiredstring · enum · requiredstring · requiredboolean · requiredboolean · requiredboolean · requiredinteger · int32 · requirednumber · double · requiredstring · requiredstring · requiredstring · enum · requiredstringstringstringstring · enum · requiredstringstringinteger · int32 · requiredstringstringstringstring · requiredstring · requiredinteger · int32 · requiredstring · requiredstringstringstringstring · requiredstring · requiredstring · requiredboolean · requiredinteger · int32 · requiredstringstring · requiredstringstring · requiredboolean · requirednumber · doublenumber · doublenumber · doublestring · requiredstring · requiredstring · requiredstring · enum · requiredinteger · int32 · requiredboolean · requiredstringstringinteger · int32 · requiredinteger · int32 · requiredstring[]string[]string · enumstringstring · enumstringstring · requirednumber · double · requiredstring · requiredstring · enum · requiredstringstring · requiredstring · requiredstring · requiredstring · date-time · requiredstring · enum · requiredstring · enum · requiredstringstringstring · requiredstring · requiredstring · requiredstring · date-time · requiredstring · enum · requiredstring · enum · requiredstringstringstring · requiredstring · requiredboolean · requiredboolean · requiredboolean · requirednumber · doublebooleanstring · requiredstring · requiredstring · date-time · requiredstring · date-time · requiredstring · requiredstring · requiredinteger · int32 · requiredboolean · requiredboolean · requiredstringstringstringstring · requiredstring · requiredstring · date-time · requiredstring · date-time · requiredstring · requiredstring · requiredinteger · int32 · requiredboolean · requiredboolean · requiredstringstringstringstringstring · requiredstring · requiredstring · date-time · requiredstring · date-time · requiredstring · requiredboolean · requirednumber · double · requiredstringstring · requiredstringstring · requiredstring · requiredstring · requiredstring · requiredstring · date-time · requiredstring · date-time · requiredstring · enum · requiredstringstring · requiredstring · requiredstring · date-time · requiredstring · date-time · requiredstring · requiredinteger · int32 · requiredboolean · requiredboolean · requiredboolean · requiredstringstringstringstringstringstring · requiredstring · requiredinteger · int32 · requiredinteger · int32 · requiredboolean · requiredstring · requiredstring · requiredstring · requiredinteger · int32 · requiredboolean · requiredstring · enum · requiredinteger · int32 · requiredstring · requiredstring · requiredstring · requiredstring · requiredstring · requiredstring · enum · requiredstring · enum · requiredstring · date-span · requiredstring · date-span · requiredboolean · requiredboolean · requiredboolean · requirednumber · double · requirednumber · double · requiredstring · requiredstring · requiredstring · requiredstring · requiredstring · requiredstring · requirednumber · doublestringnumber · doublestringnumber · double · requirednumber · double · requiredstring · enum · requiredstringstringstring · enum · requiredstring · requiredstring · enum · requiredboolean · requiredboolean · requiredstring · enum · requiredstring · enum · requiredstring · requiredstring
CartLine
productIdquantityobject[] · required
CheckoutDeliveryStepSettings
standardDeliveryAddressEnabledshowDeliveryLabelobject[] · required
object
CheckoutSettings
showDeliveryCostshowPricessaveCustomAddressobject · required
CheckoutStepsSettings
object · required
object · required
object · required
object · required
object · required
ClientProfile
object · required
object · required
cloudMessagingTokenpreferredLanguageCommerceAppHomeHeaderType
string · enum
Enum values:
CompanyName
CompanyLogo
CompanyLogoInverted
CompanyIcon
CompanyIconInverted
CommerceAppHomeSettings
headerTypeEnum values:
CompanyName
CompanyLogo
CompanyLogoInverted
CompanyIcon
CompanyIconInverted
showUspBarCommerceAppSettings
appNameappShortNameappDescriptionthemeColorthemeCssVariablesobject[] · required
object[] · required
object · required
allowInBrowserOnPlatformsEnum values:
Ipad
Iphone
Ios
Android
Phablet
Tablet
Cordova
Capacitor
CommerceCartSettings
showDeliveryCostshowPricesshowUspBarCommerceCategorySettings
defaultImagethumbnailFitEnum values:
Contain
Cover
ScaleDown
object · required
CommerceCheckoutDeliveryStepSettings
standardDeliveryAddressEnabledshowDeliveryLabelobject
CommerceCheckoutField
displayNamemandatorymaxLengthCommerceCheckoutStepsSettings
object · required
object · required
object · required
object · required
CommerceOrderHistorySettings
showPricesshowOrderedAtChannelshowOrderStatusallowRequestBackorderDeletionshowTotalsPerSalesOrderLineshowDeliveryCostCommercePrice
enabledvatTypeEnum values:
Default
Excluding
Including
CommerceProductPageSettings
showGtinshowSkushowConfiguredProductNameCommerceProductSettings
showPricesdefaultImagethumbnailFitEnum values:
Contain
Cover
ScaleDown
object · required
CommerceWebSettings
themeCssVariablesobject[] · required
object[] · required
showUspBarshowHorizontalNavigationlimitHorizontalNavigationItemshorizontalNavigationLimitCreateCommerceSalesOrderLineRequest
quantityproductIdobject[]
CreateCommerceSalesOrderRequest
channelobject · required
deliveryMethodEnum values:
Delivery
Pickup
externalReferencedescriptioncurrencyobject
object
GetCommerceMessage
severityEnum values:
Success
Info
Danger
shortMessagelongMessageGetCommerceProductCategoriesHierarchyResponse
object[] · required
totalGetCommerceProductCategoryDisplayContentResponse
object · required
excerptdescriptionlanguageGetCommerceProductCategoryHierarchyResponse
idslugdisplayOrdernameobject[] · required
languageparentIdimageGetCommerceProductCategoryResponse
idnameslugactivedisplayOrderimageobject
object
GetCommerceProductDisplayContentResponse
object · required
languagedescriptionGetCommerceProductPriceResponse
productIdshouldRequestPriceobject[] · required
A list of messages to display to the user as additional information. Can only be set in Rules.
salesPricesuggestedRetailPricecustomerPriceobject
GetCommerceProductResponse
idnameslugproductTypeEnum values:
SimpleProduct
ConfigurableProduct
GroupedProduct
BundledProduct
object[] · required
object[] · required
object[] · required
object[] · required
object · required
displayOrderobject[] · required
object[] · required
showStockobject
skugtinobject
object
GetCommerceProductsRequest
takeFor paged querying, the amount of records to take (defaults to 100)
skipFor paged querying, the amount of records to skip (defaults to 0)
idscategoryIdsFor filtering data, filters on the exact value in the categories array
typeEnum values:
SimpleProduct
ConfigurableProduct
GroupedProduct
BundledProduct
object[]
queryFor searching, the query used when searching
sortOrderEnum values:
Asc
Desc
sortByFor sorting data, the name of the property used to sort by
GetCommerceSalesOrderLineResponse
idobject[] · required
quantityobject · required
statusobject · required
GetCommerceSalesOrderPickup
statusEnum values:
Open
Ready
Completed
Canceled
object · required
commentsGetCommerceSalesOrderResponse
idorderNumberchannelorderedAtdeliveryMethodEnum values:
Delivery
Pickup
object · required
orderingStatusEnum values:
Draft
Completed
Canceled
object · required
object · required
object[] · required
object
externalReferencedescriptionobject
object
GetCommerceSalesOrderWithLinesResponse
idorderNumberchannelorderedAtdeliveryMethodEnum values:
Delivery
Pickup
object · required
orderingStatusEnum values:
Draft
Completed
Canceled
object · required
object · required
object[] · required
object[] · required
object
externalReferencedescriptionobject
object
GetCommerceSettingsResponse
workspaceobject · required
organizationIdobject · required
object · required
enableMultilingualismobject · required
object[] · required
object · required
object · required
object · required
object · required
object · required
showVatTogglepublicShowPricesobject · required
object
object
object
GetCommerceStockResponse
object · required
object[] · required
A list of messages to override the default In Stock message(s). Can only be set in Rules.
object[]
totalisInStockGetContentPageResponse
idworkspacecreatedAtmodifiedAturldisplayNamedisplayOrdershowInMenushowInFooterexternalReferencelanguagegroupNameGetContentPageWithBodyResponse
idworkspacecreatedAtmodifiedAturldisplayNamedisplayOrdershowInMenushowInFooterexternalReferencelanguagegroupNamebodyGetCurrencyResponse
idworkspacecreatedAtmodifiedAtcodeisDefaultconversionRateexternalReferenceGetCurrentAccountResponse
displayNameobject[] · required
externalReferenceobject
object
GetCurrentClientLoginResponse
object · required
emailusernameGetFavouriteProductResponse
idworkspacecreatedAtmodifiedAtoriginEnum values:
Personal
Suggested
object · required
object · required
externalReferenceGetLocationResponse
idworkspacecreatedAtmodifiedAtnamedisplayOrderobject · required
isWarehouseisPickupLocationisStockLocationobject[] · required
object[] · required
externalReferenceemaildescriptionphoneNumberimageGetProductFilterOptionResponse
labelvaluecountdisplayOrderisActiveGetProductFilterResponse
attributeIdattributeNamecategoryIddisplayOrderisActiveobject[] · required
GetProductLinkResponse
linkTypeEnum values:
Unspecified
ConfiguredProduct
ConfigurableProduct
GroupedProduct
BundledProduct
RelatedProduct
UpSellProduct
CrossSellProduct
displayOrderobject · required
GetStockLocationResponse
idnameexternalReferenceHyperlink
urldescriptiontypeEnum values:
Website
Video
Document
OpeningTime
dayOfWeekEnum values:
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
opensAtclosesAtPriceSettings
showSalesPriceshowCustomerPriceshowSuggestedRetailPricePriceTotal
amountvatAmountobject[] · required
ProductAttributeEntityReference
idnametypeProductCategoryEntityReference
idnametypeProductLinkType
string · enum
Enum values:
Unspecified
ConfiguredProduct
ConfigurableProduct
GroupedProduct
BundledProduct
RelatedProduct
UpSellProduct
CrossSellProduct
ProductPacking
packingUnitpackingContainerpackingQuantityunitProductSalesSettings
minimumQuantityquantityStepProductType
string · enum
Enum values:
SimpleProduct
ConfigurableProduct
GroupedProduct
BundledProduct
SalesOrderDelivery
statusEnum values:
Open
Delivering
Completed
Canceled
object
attendeeNamecommentsSalesOrderProcessing
statusEnum values:
Open
InProgress
Completed
Canceled
SortSettings
sortBysortDirectionEnum values:
Asc
Desc
StockDisplayType
string · enum
Enum values:
None
Boolean
Quantity
QuantityByLocation
QuantityByLocationInline
StockSettings
allowAnonymousStockAccessallowOutOfStockOrderingdisplayTypeEnum values:
None
Boolean
Quantity
QuantityByLocation
QuantityByLocationInline
UpdateSalesOrderPickupRequest
statusEnum values:
Open
Ready
Completed
Canceled
locationIdcomments