First run

Getting Started Tutorial

A screenshot-led walkthrough for Shopify brands that want to install OrderBrief Atlas, train operators quickly, and run the order-note workflow from dashboard triage to Shopify Admin order surfaces.

Understand the operator path

Use this sequence when onboarding staff so they know which surface to open first and what each screen is for.

OrderBrief Atlas turns merchant-authored order notes into an internal fulfillment brief. It is best used by brands that regularly see rush requests, gift notes, date-sensitive instructions, customization details, or warning text in Shopify order notes.

Workflow diagram showing the normal OrderBrief Atlas path from install to dashboard and Shopify Admin order surfaces.
Start in Shopify Admin, triage in the embedded dashboard, and move to Shopify Admin order surfaces only when order-level action is needed.

Follow the daily workflow

Each step pairs the recommended merchant action with the closest visible surface in the app.

Step 1

Know what the app is for

OrderBrief Atlas is an internal order-review tool, not a customer messaging system. It reads merchant-authored order notes, detects signals such as urgent, gift, date-sensitive, customization, and warning language, and then creates a summary, action text, and risk score for internal staff.

  • Use it when operators need to review order notes faster and more consistently
  • Use it when multiple staff members need the same checklist state and order-level context
  • Use it when brands want a repeatable path from overview triage to order action inside Shopify Admin
Step 2

Start from Shopify Admin and check store readiness

Start the install from Shopify Admin, complete OAuth, and then open Apps > OrderBrief Atlas. Before operators assume a button is broken, confirm the store's current plan and approval state from Plan & Billing.

  • Starter stores can review generated summaries and monitoring surfaces, but manual reprocess and checklist actions can be locked
  • If Shopify approval for protected customer data is still pending, some order-driven behavior can remain limited until that review is complete
  • Plan-aware and approval-aware messaging appears in the dashboard and supported Shopify Admin extensions
OrderBrief Atlas Plan and Billing tab showing plan-aware status and next billing step.
Plan & Billing is the first place to check when reprocess or checklist buttons are locked.
Step 3

Open the embedded dashboard and learn the five tabs

The embedded dashboard is the main control surface for Overview triage, Orders review, Plan & Billing checks, Processing Rules, and Webhook Logs. Most merchant training can be taught from these five tabs alone.

  • Overview: decide what to inspect first
  • Orders: read summary, action text, signals, checklist state, and the latest error
  • Plan & Billing: confirm lock state and the next approval or upgrade step
  • Processing Rules: tune keywords and retention to match merchant note language
  • Webhook Logs: diagnose event receipt, processing completion, and failure reasons
OrderBrief Atlas embedded dashboard with the current five-tab merchant workflow.
The dashboard is the operating home base for merchants and fulfillment teams.
Step 4

Use Overview to decide what needs attention first

Start daily work in Overview. Review Needs attention now first, then use Next steps to decide whether the team should move into Orders, Plan & Billing, or Webhook Logs.

  • Use the attention cards to surface urgent, date-sensitive, gift, or customization-heavy orders quickly
  • Use the hero metrics to understand tracked orders, open checklist state, and the most recent success or failure
  • Keep Overview as the first screen for operators who work through order notes every day
OrderBrief Atlas Overview tab showing needs-attention cards and next-step guidance.
Overview is the fastest place to spot what matters now and why a workflow may be blocked.
Step 5

Use Orders to read summary, action text, signals, and errors

Move to Orders when staff need order-level detail. This is where the team reads why a note was classified the way it was, what action the app recommends next, and whether the last processing attempt failed.

  • Focused order helps when someone opens the app from a specific Shopify order
  • Summary and Action text explain the order in operator-friendly language
  • Signals, risk score, and the latest error help teams explain the result to one another without reading the original note again
OrderBrief Atlas Orders tab with order summary, action text, signal list, and focused order view.
Orders is the screen for reading the brief, understanding the signal keywords, and checking whether the latest run succeeded.
Step 6

Adjust keywords and retention in Processing Rules, then inspect Webhook Logs when flow looks wrong

Merchant note patterns change over time, so the app needs periodic tuning. Adjust keywords and retention in Processing Rules, and use Webhook Logs whenever the team needs to confirm whether Shopify events arrived and whether processing completed successfully.

  • Update urgent, gift, date-sensitive, customization, and warning keywords to match the store's real note language
  • Keep retention aligned with the store's internal operating policy
  • Check Webhook Logs first when a note changed but the summary did not refresh, or when a failure message appears
OrderBrief Atlas Processing Rules tab with keyword groups and retention settings.
Processing Rules is where the app learns the merchant's real order-note vocabulary.
OrderBrief Atlas Webhook Logs tab with event history, status, and failure context.
Webhook Logs answers whether Shopify sent the event, whether the app processed it, and why it failed if it did not.
Step 7

Use the Shopify Admin order surfaces for order-level review and reprocess

If staff spend most of their day inside Shopify order detail screens, they do not need to leave Admin to see the brief. Use OrderBrief Atlas Summary for context and Order Action when a single order needs a fresh pass.

  • Open in OrderBrief Atlas jumps to the same order inside the dashboard
  • Queue reprocess is the quickest way to rerun a note after note text changes
  • Mark checklist and Undo checklist keep the review state shared across the team when the current plan allows it
OrderBrief Atlas Summary block inside Shopify Admin order details.
The summary block mirrors the same brief, signals, and checklist state the team sees in the dashboard.
OrderBrief Atlas order action panel inside Shopify Admin.
Order Action is designed for one-order reruns and operator workflows, not customer-facing messaging.
Step 8

Use Bulk Action for batches and keep the workflow simple

When multiple orders need a rerun at once, switch to the Shopify order index and use Bulk Action. This is the best fit for note-pattern changes, backfills after tuning keywords, or operator catch-up after a busy period.

  • Select the target orders in Shopify Admin and launch OrderBrief Atlas Bulk Action from the Actions menu
  • Queue selected orders, then return to Overview, Orders, or Webhook Logs to confirm the outcome
  • Keep the routine simple: Overview first, Orders second, Webhook Logs before retrying, Shopify Admin order surfaces when staff are already inside an order
OrderBrief Atlas bulk action surface for Shopify Admin order selection.
Bulk action is the fastest way to push several orders back through the processing queue.

Best practices

Use the app as an internal order-note workflow, and keep the team trained on the same path.

  • Review high-risk notes first from Overview before reading individual orders in detail
  • Keep Processing Rules updated whenever merchant note language changes
  • Use Webhook Logs to confirm event flow before asking staff to retry work manually
  • Keep stores on a paid plan if the team depends on manual reprocess and checklist actions