Heartwork Commerce API

Workspaces

Endpointhttps://api.heart.work

Download schema

GET

https://api.heart.work

/commerce-api/workspaces/settings

Responses

workspace

string · required

object · required

organizationId

string · required

object · required

enableMultilingualism

boolean · required

object · required

object[] · required

object · required

showVatToggle

boolean · required

publicShowPrices

boolean · required

object · required

object

GET/commerce-api/workspaces/settings

curl --request GET \
  --url https://api.heart.work/commerce-api/workspaces/settings

shell

Example Responses

{
  "workspace": "workspace",
  "company": {
    "name": "name",
    "fullLogo": {
      "url": "url",
      "invertedUrl": "invertedUrl"
    },
    "iconOnlyLogo": {
      "url": "url",
      "invertedUrl": "invertedUrl"
    }
  },
  "organizationId": "organizationId",
  "productSettings": {
    "showPrices": true,
    "defaultImage": "defaultImage",
    "thumbnailFit": "Contain",
    "sorting": {
      "sortBy": "sortBy",
      "sortDirection": "Asc"
    }
  },
  "categorySettings": {
    "defaultImage": "defaultImage",
    "thumbnailFit": "Contain",
    "sorting": {
      "sortBy": "sortBy",
      "sortDirection": "Asc"
    }
  },
  "webSettings": {
    "themeCssVariables": "themeCssVariables",
    "translations": [
      {
        "language": "language",
        "translations": {}
      }
    ],
    "fontStylesheets": [
      {
        "name": "name",
        "url": "url",
        "integrity": "integrity"
      }
    ],
    "showUspBar": true,
    "showHorizontalNavigation": true,
    "limitHorizontalNavigationItems": true,
    "horizontalNavigationLimit": 0
  },
  "app": {
    "appName": "appName",
    "appShortName": "appShortName",
    "appDescription": "appDescription",
    "themeColor": "themeColor",
    "themeCssVariables": "themeCssVariables",
    "translations": [
      {
        "language": "language",
        "translations": {}
      }
    ],
    "fontStylesheets": [
      {
        "name": "name",
        "url": "url",
        "integrity": "integrity"
      }
    ],
    "home": {
      "headerType": "CompanyName",
      "showUspBar": true
    },
    "allowInBrowserOnPlatforms": [
      "Ipad"
    ]
  },
  "enableMultilingualism": true,
  "csp": {},
  "socialLinks": [
    {
      "label": "label",
      "url": "url",
      "icon": "icon"
    }
  ],
  "checkout": {
    "showDeliveryCost": true,
    "showPrices": true,
    "saveCustomAddress": true,
    "steps": {
      "data": {
        "destinationReference": {
          "displayName": "displayName",
          "mandatory": true,
          "maxLength": 0
        },
        "customerReference": {
          "displayName": "displayName",
          "mandatory": true,
          "maxLength": 0
        },
        "projectReference": {
          "displayName": "displayName",
          "mandatory": true,
          "maxLength": 0
        },
        "comments": {
          "displayName": "displayName",
          "mandatory": true,
          "maxLength": 0
        }
      },
      "delivery": {
        "deliveryInstructions": {
          "displayName": "displayName",
          "mandatory": true,
          "maxLength": 0
        },
        "standardDeliveryAddressEnabled": true,
        "showDeliveryLabel": true,
        "messages": [
          {
            "message": "message",
            "severity": "Success"
          }
        ]
      },
      "payment": {
        "showInvoiceLabel": true
      },
      "overview": {
        "termsAndConditionsUrl": "termsAndConditionsUrl"
      },
      "pickup": {
        "messages": [
          {
            "message": "message",
            "severity": "Success"
          }
        ]
      }
    }
  },
  "cart": {
    "showDeliveryCost": true,
    "showPrices": true,
    "showUspBar": true
  },
  "orderHistory": {
    "showPrices": true,
    "showOrderedAtChannel": true,
    "showOrderStatus": true,
    "allowRequestBackorderDeletion": true,
    "showTotalsPerSalesOrderLine": true,
    "showDeliveryCost": true
  },
  "productPage": {
    "showGtin": true,
    "showSku": true,
    "showConfiguredProductName": true
  },
  "accountPage": {
    "showExternalReference": true
  },
  "showVatToggle": true,
  "stockSettings": {
    "allowAnonymousStockAccess": true,
    "allowOutOfStockOrdering": true,
    "displayType": "None"
  },
  "publicShowPrices": true,
  "priceSettings": {
    "salesPrice": {
      "enabled": true,
      "vatType": "Default"
    },
    "suggestedRetailPrice": {
      "enabled": true,
      "vatType": "Default"
    },
    "customerPrice": {
      "enabled": true,
      "vatType": "Default"
    }
  }
}

plain

Stocks

Heartwork Commerce API

Workspaces

Endpointhttps://api.heart.work

Download schema

GET

https://api.heart.work

/commerce-api/workspaces/settings

Responses

workspace

string · required

object · required

organizationId

string · required

object · required

enableMultilingualism

boolean · required

object · required

object[] · required

object · required

showVatToggle

boolean · required

publicShowPrices

boolean · required

object · required

object

GET/commerce-api/workspaces/settings

curl --request GET \
  --url https://api.heart.work/commerce-api/workspaces/settings

shell

Example Responses

{
  "workspace": "workspace",
  "company": {
    "name": "name",
    "fullLogo": {
      "url": "url",
      "invertedUrl": "invertedUrl"
    },
    "iconOnlyLogo": {
      "url": "url",
      "invertedUrl": "invertedUrl"
    }
  },
  "organizationId": "organizationId",
  "productSettings": {
    "showPrices": true,
    "defaultImage": "defaultImage",
    "thumbnailFit": "Contain",
    "sorting": {
      "sortBy": "sortBy",
      "sortDirection": "Asc"
    }
  },
  "categorySettings": {
    "defaultImage": "defaultImage",
    "thumbnailFit": "Contain",
    "sorting": {
      "sortBy": "sortBy",
      "sortDirection": "Asc"
    }
  },
  "webSettings": {
    "themeCssVariables": "themeCssVariables",
    "translations": [
      {
        "language": "language",
        "translations": {}
      }
    ],
    "fontStylesheets": [
      {
        "name": "name",
        "url": "url",
        "integrity": "integrity"
      }
    ],
    "showUspBar": true,
    "showHorizontalNavigation": true,
    "limitHorizontalNavigationItems": true,
    "horizontalNavigationLimit": 0
  },
  "app": {
    "appName": "appName",
    "appShortName": "appShortName",
    "appDescription": "appDescription",
    "themeColor": "themeColor",
    "themeCssVariables": "themeCssVariables",
    "translations": [
      {
        "language": "language",
        "translations": {}
      }
    ],
    "fontStylesheets": [
      {
        "name": "name",
        "url": "url",
        "integrity": "integrity"
      }
    ],
    "home": {
      "headerType": "CompanyName",
      "showUspBar": true
    },
    "allowInBrowserOnPlatforms": [
      "Ipad"
    ]
  },
  "enableMultilingualism": true,
  "csp": {},
  "socialLinks": [
    {
      "label": "label",
      "url": "url",
      "icon": "icon"
    }
  ],
  "checkout": {
    "showDeliveryCost": true,
    "showPrices": true,
    "saveCustomAddress": true,
    "steps": {
      "data": {
        "destinationReference": {
          "displayName": "displayName",
          "mandatory": true,
          "maxLength": 0
        },
        "customerReference": {
          "displayName": "displayName",
          "mandatory": true,
          "maxLength": 0
        },
        "projectReference": {
          "displayName": "displayName",
          "mandatory": true,
          "maxLength": 0
        },
        "comments": {
          "displayName": "displayName",
          "mandatory": true,
          "maxLength": 0
        }
      },
      "delivery": {
        "deliveryInstructions": {
          "displayName": "displayName",
          "mandatory": true,
          "maxLength": 0
        },
        "standardDeliveryAddressEnabled": true,
        "showDeliveryLabel": true,
        "messages": [
          {
            "message": "message",
            "severity": "Success"
          }
        ]
      },
      "payment": {
        "showInvoiceLabel": true
      },
      "overview": {
        "termsAndConditionsUrl": "termsAndConditionsUrl"
      },
      "pickup": {
        "messages": [
          {
            "message": "message",
            "severity": "Success"
          }
        ]
      }
    }
  },
  "cart": {
    "showDeliveryCost": true,
    "showPrices": true,
    "showUspBar": true
  },
  "orderHistory": {
    "showPrices": true,
    "showOrderedAtChannel": true,
    "showOrderStatus": true,
    "allowRequestBackorderDeletion": true,
    "showTotalsPerSalesOrderLine": true,
    "showDeliveryCost": true
  },
  "productPage": {
    "showGtin": true,
    "showSku": true,
    "showConfiguredProductName": true
  },
  "accountPage": {
    "showExternalReference": true
  },
  "showVatToggle": true,
  "stockSettings": {
    "allowAnonymousStockAccess": true,
    "allowOutOfStockOrdering": true,
    "displayType": "None"
  },
  "publicShowPrices": true,
  "priceSettings": {
    "salesPrice": {
      "enabled": true,
      "vatType": "Default"
    },
    "suggestedRetailPrice": {
      "enabled": true,
      "vatType": "Default"
    },
    "customerPrice": {
      "enabled": true,
      "vatType": "Default"
    }
  }
}

plain

Stocks