Skip to main content

Ecommerce App

Browse, purchase, and manage products tied to your assets and systems — from physical parts and kits to digital apps and data subscriptions — with full order tracking and inquiry management built in.


🏪 Shop

The Shop is where customers browse and purchase products. It is organized into three sections displayed top to bottom on the page.

Highlighted collections that have been marked as featured by an administrator. Each collection is displayed as a card with its name and cover image. Clicking a collection card opens its product list.

Collections

All non-featured collections available in the account. Each collection is displayed as a card with its name and cover image. Clicking a collection card opens its product list.

⚠️ Non-obvious: A product must be assigned to at least one collection — or marked as a Featured Product — to appear anywhere in the Shop. Products that exist in the catalog but are not assigned to a collection and are not featured will not be visible to customers.

Individual products marked as featured by an administrator, displayed as cards below the collections. Clicking a product card opens the product detail page.

⚠️ Non-obvious: The Shop only shows products that are set to Live on Site in the Products admin. If a product is not live, it will not appear even if it is assigned to a collection.


📦 Collection Products Page

Clicking a collection opens the Collection Products page, showing all products within that collection as cards.

What does each element do?
ElementDescription
BreadcrumbShop / [Collection Name] — click Shop to return
Product cardDisplays product name and starting price
Product imageCover image for the product

Clicking a product card opens the Product Detail page.


🔍 Product Detail Page

The product detail page shows full information for a single product and is where customers add items to their cart.

What does each field mean?
FieldDescription
Product nameName of the product displayed as the page heading
DescriptionShort description shown below the name
TypeProduct category — Part, Asset, Data, App, etc.
Reference NumberThe reference ID linking this product to the physical part, asset, or app
SKUStock keeping unit identifier for this product
Variant dropdownsIf the product has multiple variants (e.g., size, configuration), each variant appears as a labeled dropdown. Selecting a variant combination updates the price.
QuantityEditable quantity field — defaults to 1
PricePrice for the selected variant and quantity
+ ADD TO CARTAdds the selected variant and quantity to the cart

⚠️ Non-obvious: If a product has multiple variants, you must select an option in each variant dropdown before the price reflects your selection. Adding to cart without selecting all variants may result in a default selection being applied.


🛍️ Cart

The Cart page shows all items currently added and allows quantity adjustments before checkout.

Cart Table

What does each column mean?
ColumnDescription
ProductProduct thumbnail, name (as a clickable link back to the product page), SKU, and selected variant
QuantityEditable quantity field per line item
TotalLine item total (price × quantity)
Action🔴 Remove button to delete the item from the cart

Cart Summary and Actions

What does each element do?
ElementDescription
SubtotalSum of all line item totals
PRODUCT INQUIRY (blue button)Opens the Inquiry flow to request a quote or send product questions without completing a purchase
CHECK OUT (blue button)Proceeds to the checkout flow to complete the purchase

⚠️ Non-obvious: The cart holds one variant selection per product at a time. If you add the same product with a different variant, the latest selection replaces the previous one. Add different products separately to keep them as distinct line items.


📋 Inquiry

The Inquiry flow allows customers to submit a product inquiry or request a quote without completing a full purchase. Accessed via the PRODUCT INQUIRY button in the cart.

Inquiry Page Layout

Left panel — Contact steps:

What does each field mean?
StepFieldDescription
1 — Your EmailEmail AddressPre-populated with your account email — read-only
Confirmation textConfirms a receipt will be sent to this address
CONTINUE buttonAdvances to the next step
2 — Additional EmailAdditional EmailSecondary email address shown for reference

Right panel — Order summary:

What does each element do?
ElementDescription
Product image and nameEach cart item listed with its image
QuantityPer item quantity
SKUProduct SKU
VariantSelected variant for each item
SubtotalSum of cart items
ShippingShown as FREE if no shipping charge applies
TotalFinal total

⚙️ Products (Admin)

The Products section is the administrator view for managing the product catalog. Accessed via Ecommerce → Products in the sidebar.

Products Dashboard Tiles

TileColorWhat It Shows
Live Products🟢 GreenCount of products currently set to Live on Site
Non-Live Products🟠 OrangeCount of products not yet published to the Shop
Collections🔵 BlueTotal number of collections in the account

Products / Collections Tabs

TabWhat It Shows
PRODUCTSFull product catalog list
COLLECTIONSAll collections and their management options

Product List — Columns

What does each column mean?
ColumnDescription
ImageProduct thumbnail or placeholder
NameProduct name
Product TypeCategory of the product (e.g., Data, Part, Asset, App)
Reference IdThe reference ID linking the product to a physical or digital item
DetailsAdditional product details if available
LiveToggle switch — blue = Live on Site (visible in Shop); gray = not live (hidden from Shop)
Action✏️ EDIT and 🗑️ DELETE buttons

⚠️ Non-obvious: The Live on Site toggle controls Shop visibility instantly. Switching a product to not-live removes it from the Shop immediately without any confirmation dialog.

⚠️ Non-obvious: Deleting a product archives it rather than permanently erasing it, so that historical order records remain intact.

➕ Create / Edit Product — 3-Step Form

Products are created or updated through a 3-step form.

Step 1 — Name & Description

What does each field mean?
FieldDescription
NameProduct name as it will appear in the Shop
DescriptionShort marketing description
DetailsExtended product details
TypeProduct type — App, Part, or Asset
Reference IdAuto-populated if App type is selected; manually entered for Part or Asset
FeaturedToggle to mark this product as a Featured Product in the Shop

Step 2 — Create Prices (Variants)

Each row in the pricing step represents one purchasable variant of the product.

What does each field mean?
FieldDescription
Variant NameThe dimension being varied (e.g., Size, Color, Configuration)
NameThe specific option value (e.g., Small, Blue, Deluxe)
TypeOne-time purchase or Recurring (subscription)
PriceThe price for this variant
Billing CycleFor recurring variants: Daily, Monthly, or Yearly
Trial Period DaysNumber of free trial days before billing begins (recurring only)
StockAvailable inventory quantity for this variant

⚠️ Non-obvious: If you need to change the price amount, billing cycle, or type (one-time vs. recurring) on an existing variant, the system deletes the old variant and creates a new one automatically. This is expected behavior — the product record is preserved.

Step 3 — Photos

Upload one or more product photos. These appear on the product detail page and in collection cards.


📋 Collections Tab — Actions

ButtonFunction
CREATE NEW COLLECTIONOpens the 2-step collection creation form
EDITOpens the collection update form
VIEWOpens the collection product list (read-only)
DELETEPermanently deletes the collection (products are not deleted)

Collection Creation — 2 Steps:

StepFields
1 — Title and ProductsCollection name, Featured toggle, product selector (add/remove products from this collection)
2 — Cover ImageUpload a cover image displayed on the Shop collection card

📊 Orders

The Orders section provides a full view of all purchases, their payment status, and fulfillment progress. Accessed via Ecommerce → Orders in the sidebar.

Orders Dashboard Tiles

Three charts appear at the top of the Orders page.

Order Status

SegmentColorMeaning
Created🔵 BlueOrder placed but payment not yet confirmed
Paid🔴 PinkPayment received — awaiting fulfillment
Fulfilled🟠 OrangeOrder shipped or delivered

Subscription Status — Shows subscription statuses from the payment system. Visible to administrators only when payment integration is enabled.

Payment Status — Shows payment transaction statuses. Visible to administrators only when payment integration is enabled.

Orders Tabs

TabWhat It Shows
CREATEDOrders placed but not yet paid
PAIDOrders paid and ready to process
FULFILLEDOrders shipped or completed

Orders Table — Columns (All Tabs)

What does each column mean?
ColumnDescription
Order IdSystem-generated unique order identifier
Created DateDate and time the order was placed
EmailCustomer email address associated with the order
AmountTotal order amount
AddressShipping address provided at checkout
Order TypeType of purchase

Additional columns by tab:

TabExtra Columns
CREATEDAdmin may see a PAID button per row if payment integration is not enabled
PAIDStatus dropdown (Ordered, Processed, Received, Shipped), Tracking Number, NOTIFY button
FULFILLEDTracking Number
What do the controls do?
ControlDescription
Status dropdownChange the internal fulfillment status: Ordered → Processed → Received → Shipped
Tracking NumberDisplayed as N/A until a shipping tracking number is entered
🔔 NOTIFY (blue button)Sends a status notification email to the customer. When status is set to Shipped, this also records the tracking number and moves the order to the Fulfilled tab.

⚠️ Non-obvious: Setting the status dropdown to Shipped and clicking NOTIFY is the action that moves an order from the PAID tab to the FULFILLED tab. Simply selecting Shipped without clicking NOTIFY does not advance the order.

⚠️ Non-obvious: For accounts where payment integration is disabled, new orders arrive in the CREATED tab with a PAID button visible on each row. An administrator must manually click this button to mark the order as paid and move it to the PAID tab.

Order Details Page

Clicking any order row opens the Order Details page showing the individual line items in that order.

What does each column mean?
ColumnDescription
Product NameName of the purchased product
TypePurchase type — Onetime or Subscription
VariantThe specific variant purchased
QuantityNumber of units ordered
AmountLine item price
StatusFulfillment or payment status for this line item
ErrorAny error message associated with a failed payment or fulfillment attempt

🔄 Workflows

Workflow 1 — Browse and Purchase a Product

  1. Open the Ecommerce app and click Shop in the sidebar
  2. Browse Featured Collections or Collections — click a collection card to see its products
  3. Click a product card to open the product detail page
  4. If the product has variants, select your options from the dropdown fields
  5. Set the Quantity field as needed
  6. Click + ADD TO CART
  7. Continue browsing or click the cart icon to proceed
  8. On the Cart page, review your items and adjust quantities if needed
  9. Click CHECK OUT to complete the purchase

Result: The product is added to your order. On successful checkout, a confirmation email is sent to your account email and the order appears in the Orders section.


Workflow 2 — Submit a Product Inquiry

  1. Add the products you want to inquire about to your cart (follow Workflow 1 steps 1–8)
  2. On the Cart page, click PRODUCT INQUIRY instead of CHECK OUT
  3. Confirm your email address on the Inquiry page
  4. Review the order summary on the right panel — Subtotal, Shipping, and Total are shown
  5. Click CONTINUE to submit the inquiry

Result: An inquiry is submitted to the account. You receive a receipt at your email address. No payment is taken — the inquiry is a request for a quote or follow-up communication.


Workflow 3 — Publish a New Product to the Shop (Admin)

  1. Open Ecommerce → Products in the sidebar
  2. Click in the Product List toolbar
  3. Step 1 — Name & Description: enter the product name, description, type, and reference ID. Toggle Featured on if this should appear in the Featured Products section. Click Next.
  4. Step 2 — Create Prices: add one or more variants with their names, prices, and billing type. Click Next.
  5. Step 3 — Photos: upload one or more product images. Click Save.
  6. Back in the Product List, find the new product and toggle the Live on Site switch to blue
  7. Assign the product to a collection via the Collections tab if it should appear under a category

Result: The product is live in the Shop and visible to customers. It appears in the assigned collection and/or the Featured Products section if marked as featured.


Workflow 4 — Fulfill a Paid Order (Admin)

  1. Open Ecommerce → Orders in the sidebar
  2. Click the PAID tab to see all paid, unfulfilled orders
  3. Locate the order to fulfill
  4. Use the Status dropdown to update the internal fulfillment status as work progresses (Ordered → Processed → Received → Shipped)
  5. When the item has shipped, select Shipped from the Status dropdown, enter the courier Tracking Number, and click NOTIFY

Result: The customer receives a shipping notification email with the tracking number, and the order moves to the FULFILLED tab.

📌 Products can also be created and updated in bulk using the Ingestion app. Three ingestion types are available for ecommerce data: Create Products, Update Product Prices, and Update Product Images. See the Ingestion documentation for details.


✅ Best Practices

  • Set products Live on Site only when fully configured. A product becomes visible to all customers the moment the Live toggle is switched on. Ensure pricing, variants, images, and collection assignments are complete before making a product live.
  • Assign every product to a collection. Products not assigned to any collection — and not marked as Featured — will not appear anywhere in the Shop, even if they are set to Live. Always check collection assignment when a product is live but not visible.
  • Use variants to handle size, configuration, and pricing tiers in one product. Rather than creating separate products for each option, add multiple price rows in Step 2. Customers will see a dropdown to select their preference on the product detail page.
  • Use the Inquiry flow for high-value or custom orders. The Product Inquiry option sends the cart contents to your team without processing payment. Use this path for custom quotes, bulk orders, or items that require manual pricing confirmation.
  • Update fulfillment status in sequence. The status dropdown in the PAID tab (Ordered → Processed → Received → Shipped) sends a notification email to the customer at each step. Clicking NOTIFY on each status change triggers the email.
  • Monitor Non-Live Products regularly. The orange Non-Live Products count on the Products dashboard can accumulate quickly. Review this list periodically to determine which products should be published, updated, or removed from the catalog.

💡 Tips & Shortcuts

TipHow
See which products are visible in the ShopCheck the Products list — items with a blue Live on Site toggle are visible to customers
Find all orders awaiting fulfillmentGo to Orders → PAID tab — every order there needs a status update or shipment action
Navigate back to the Shop from a collectionClick the Shop breadcrumb link at the top left of the collection page
See what a customer ordered in detailClick any order row in any Orders tab to open the Order Details page
Confirm a product's reference numberOpen the product detail page — the Reference Number field shows the linked part, asset, or app identifier