Skip to Content
Get started

ORBCOMMERCE DOCUMENTATION

Your first product

From an empty admin to a product your shoppers can open, by the screens alone.

You signed in to a new admin and nothing is there yet. Products → Overview shows First steps: what brings your first product to shoppers, in the order it happens. Each step ticks itself as soon as the catalog has it done, and the one to take now is lit. Once a product is live, the overview shows what needs work instead, and the steps do not come back.

Set up the shop

Open Settings → Languages and pick the languages your shop sells in; the first one is the language you write in first. Then add your shop in Settings → Shops: its currency, its country, whether its prices include tax, and where it lives, such as https://shop.example.com with products at /p/{slug}. Publish the settings when the review looks right.

Design a Type

A Type is a kind of product and the fields it has, such as a backpack's volume and colour. Open Products → Types, Add Type, name it and add its attributes. Mark the ones a product needs before it can be published, and the one a variant differs by, such as its colour. Publish the Schema, and products can be made of the Type.

Make a product

Open Products and press New product. Pick the Type, write the product's name, and keep the ref the catalog proposes from it or write the id your shop knows it by. If another product has that ref, the dialog says so while you type. Create opens the new product as a draft.

Fill in what its Type asks for. Every field saves as you leave it. A product needs at least one variant, with its SKU, before shoppers can buy it; add one under Variants.

You can also bring products in another way: Products → Import reads a CSV, JSON Lines or Excel file (Import a file), and a PIM or ERP sends them as a Source (Sync from a PIM or ERP). When you add a Source in Connections → Products, its key comes with a call you can paste into a terminal to send a first product.

Publish it

Press Publish on the product's page. If anything is missing, the page says what and where, in each language. Once it is published, the product is live, and the page's Addresses card shows where shoppers find it.

Open it in the shop

Follow the address on the product's page, or the shop's address on the last step of First steps. A published product reaches shoppers within seconds.

On this page