OpenLabel documentation

OpenLabel: product labels for Magento 2 and Hyvä. Free, MIT, Hyvä-native, one query per page, zero layout shift. Labels on listings, product pages, the cart, mini cart, wish list, compare list and order emails.

  • Install and upgrade: requirements, the three commands, production mode, upgrades, uninstall.
  • Admin: starters, the labels grid, the label form with live preview, designs, settings and permissions.
  • Storefront: markup and CSS contract, the generated stylesheet, caching and customer groups, right-to-left stores, custom themes.
  • CLI: every openlabel: command.
  • GraphQL: the openlabel_labels field on products, visibility rules and caching.
  • REST API: create, read, change and delete labels and designs from a PIM, ERP or script.
  • Export and import: moving labels between environments, and from the Smile product label module.
  • The engine: data model, conditions, indexer, variables and resolver, for developers.
  • Hyvä integration: how labels are injected into Hyvä listings and the product gallery.