Skip to Content
Work in the admin

ORBCOMMERCE DOCUMENTATION

The catalog in the admin

Design a Type, find and edit products, change many at once, keep the pictures and publish.

The panel is the catalog's module of the OrbCommerce Admin (catalog() in apps/admin/src/modules.ts): under Products the grid, Categories, Registers, Media, Import, Types and Overview, a section of Settings per part of the settings, and Connections › Products for the Sources and read keys. The shop and language every screen works in are the admin's, picked under the merchant's name, and the catalog supplies them.

Design a Type

Types → Backpack → Add attribute. Pick a kind (text, rich text, number, choice, choices, yes/no, date, image, link to a product or category, money), name it, and tick what it is: translated, required, filterable, shown in the list, searchable, a variant axis. Reuse an attribute another Type has (Brand, used by 7 Types) and filters work across Types. Publish types shows what the change does before it happens: "Removing Material hides it on 12,345 products within ten minutes; their drafts keep it under Retired until their next publish." "Waterproof is now required: 3,210 live products lack it. They stay live; the API calls it optional until they are republished." Republish everything that passes is one click.

Unit prices

Goods sold by weight, volume, length or area show their price per kilogram, litre, metre or square metre beside the price, as the price indication rules ask. Types → Coffee → Details → Unit price says what it is per: 1 kg, 1 l, 1 m or 1 m², or 100 g or 100 ml for goods sold loose where that is customary. From then on every variant needs its Net content, which sits beside the variants on the product's page: 500 g, 0.75 l, 2.5 m. A variant without it, or with a content of another kind (litres under a Type priced per kilogram), cannot be published, and the field is marked where it is missing. Goods the law exempts take a count of pieces and show no unit price.

You never type a unit price. The catalog works it out from the price in force and the net content whenever the offer is read, rounded to the cent, so a sale from Friday moves it with the price: a 500 g coffee at 9,95 € shows 19,90 € / 1 kg, and 15,92 € / 1 kg while it is on sale at 7,96 €.

Find and edit

The grid opens on every product, with keyset pages designed for catalogs of 2,000,000, and filters as you type: Type, category, status, completeness, any filterable attribute, full text over names, refs and SKUs. Sorting by a filterable attribute is instant because the Schema created its index. Click a cell, type, Tab: the row changes at once and saves in the background. Someone else editing another field of the same product is not a conflict; the same field is, and the panel shows both values inline. Fields a PIM owns are grey with the Source's name. Every key the panel answers is listed behind ?.

In Products → Filters → Category, find a category by its name or its parent path. Choosing it narrows the same product grid as Categories → Show in Products; it does not automatically include descendants. The category stays in the address, combines with search and the other filters, and appears as a removable chip. Choose Any category, remove the chip or use Clear filters to remove it; clearing only the category leaves the other filters intact. Bulk changes still apply to the grid's current selection or filter, not to a different category view.

Hand a Source product to editors

Open the imported product and use Ownership → Hand over. Confirm once: Sources will no longer change this product document, including delayed image updates, product sync and withdrawal. Only Products editors can do this; the server refuses a stale revision so someone else's edits are not lost. The Ownership card records who handed it over and when.

The product keeps its ref, every SKU, live content, draft and version history. The handover publishes nothing. Other products and the Source's global claims stay as they were; prices and stock keep their independent owners. Stopping a seed alone does not hand products over.

Change a product's Type

Open the product, then ⋯ → Change Type. Pick the new Type and, where it has variant axes, each variant's option; an option a variant already has on the same attribute is kept. Before anything changes, the catalog shows:

  • Goes away on publish: every value the new Type has no place for, product and variant level, per language. The change keeps them beside the draft, so nothing is lost until the publish.
  • Kept on the variants: the old Type's tax class or appointment needs where the new Type sets others, written on the variants so prices and bookings stay as they are.
  • New address: storefront addresses that move because the new Type has its own product page.
  • Whether the draft would publish, in the languages the live version releases, and what the new Type requires that the product lacks. A Type with an axis needs a different option per variant; a Type without one takes a single variant.

Change Type makes a draft of the new Type and publishes nothing: shoppers, search and webhooks keep the old version until you publish the whole draft as usual. The product keeps its ref, every SKU, its offers and its history. A product a Source brought keeps its Type until you hand it over. A Type that still has a live product cannot be removed from the Schema, so move and publish its products first.

Withdraw a product

Open a published product your editors keep, then ⋯ → Withdraw. It disappears from every storefront, search and OrbCart at once, and its SKUs become free: another product can take them, for example when two products merge into one. Its versions stay. ⋯ → Bring back puts the live version back as it was and claims its SKUs again; while another product holds one of them, the catalog names that product and leaves this one withdrawn. A product a Source brought is withdrawn by its Source until you hand it over.

Appointment needs

Types → Appointments sets the default capabilities, duration, buffers, lead time and shopper resource choice. On a product, Appointments lists each variant: leave Use Type default on, or turn it off to replace all needs for that variant. Turn it on again to remove the override. A missing optional value in an override does not inherit the Type's value. Save changes first, then publish as usual; unknown capabilities cannot publish.

Per appointment means once per job regardless of quantity. A 45-minute job stays 45 minutes for four configured wheels. Per unit multiplies by the appointment line quantity, not a merchant module's configuration quantities. At the front desk, a drawn end still sets the appointment's length; moving one keeps its length unless staff draw another end.

Change many at once

Select by filter ("Category Rucksäcke, Brand Deuter"), choose Set, Add, Remove or Adjust by percent for an attribute or a category, or set a price: a new base, or a sale from Friday to Monday, as an amount or percent off. See the count and a preview, run; the run applies exactly what the preview showed. A progress bar runs in the corner; Undo restores every value the job set unless someone changed it since, and takes back the job's prices while the ERP's stay.

Keep the pictures

Media is the library every picture of the family comes from, OrbPage's included: folders two levels deep, and the product pictures, which the catalog keeps, where what products and Sources bring lands. Drop files on a folder to upload them there; the same file uploaded again is the one copy, wherever it lies. A file opens beside the library with where it is used (products, categories, entries and OrbPage's pages, categories and templates), its alt text in each language and its focal point, set with a click on the picture, which every crop keeps in view. Replace keeps the file's id, so everything that shows it shows the new picture once the caches are purged; the new picture has the old one's proportions, so no page changes its layout. Delete is held back while anything shows the file: the catalog refuses it. A deleted file leaves the library's places, its search and the pickers at once, and its Undo brings it back; the catalog keeps it, and still delivers it, for 30 days, so a use on its way meanwhile (a product saved as it was deleted, a page OrbPage published a moment before) brings it back where it lay, in its folder or among the product pictures if the folder went too. Uploading its bytes again brings it back as well. After 30 days with nothing showing it, the dispatcher lets it go for good, its bytes and renditions with it. OrbPage tells the catalog which files its content shows, its pictures and the images in its text, whenever a save, publish, rollback or withdrawal changes them: its Worker reports them over a service binding to the catalog Worker's ContentPictures entrypoint, which no public route answers, each report named by its site and numbered per entry and language, so two shops' sites on one catalog never overwrite each other's reports and a report that arrives after a newer one changes nothing. Content's editors pick pictures through the same library.

Publish

Each product shows its completeness per locale (a translation, an image, a required attribute). Publish releases the locales that are complete; Publish English releases only the English texts, adds English to the locales already live and leaves other draft changes in the draft. Schedule freezes this state as a version that goes live at the given minute, on its page, in its categories and at its URL alike; Unschedule takes it back. A publish now replaces a scheduled version, which was built on the version before and would undo it. History lists versions with who and when; Restore publishes an older version again.

Product properties keep each label above its value in at most two columns. Long labels wrap, list values take the full row, and the Type’s order is preserved. A compact lock opens the Source name and where to change its value by click, tap or keyboard. Editable fields keep their controls; Source-owned and empty values remain distinct.

A card or panel with one button action makes it primary, including retry and clear-filter empty states. Field pickers, icon tools, links, destructive actions and dialog dismissals retain their roles; multiple actions keep one clear primary.

On this page