Home/Docs/Installation & settings

Installation & settings

Soryk is Shopify-native and configured entirely from the embedded admin. This page covers the install and every setting you'll touch before going live.

Everything below lives inside the Shopify admin. There is no separate dashboard to log into and no database to provision: you install the app, approve permissions, and configure it from the embedded admin.

Install & permissions

Install Soryk from the Shopify App Store and approve the requested permissions. On first open, Soryk automatically creates its metaobject definitions (25+ types) in your store, so there is nothing to set up by hand.

The app requests the Shopify scopes it needs to do its job:

Soryk also uses Shopify's protected customer-data access to read company contact details on draft orders.

i

A first-run onboarding checklist, Onboard, tracks your progress: choose a plan, invite your first agent, add your first company, set up a catalog, add commission rules, and review settings. Work through it in any order, then dismiss it.

The settings page

Open Settings in the admin. It is organised in sections, described below. Each key toggle shows its setting name and default value.

Inventory

Choose how stock is shown to agents and buyers. Mode is one of off, quantity (exact numbers), or traffic light (colour-coded bands). Set global low-stock and out-of-stock thresholds, and override thresholds per fulfillment location: Soryk lists your locations so you can tune each one.

Catalog filters

Define up to 3 filters agents and buyers can use to narrow the catalog. Each filter is one of: vendor, product type, custom tag, or metafield. Metafield options are derived automatically from your products, so you don't type values by hand. Filters are ANDed across categories (a product must match every active category) and ORed within one (any selected value in a category matches).

Ordering

These control how orders and new companies flow through approval.

requireCompanyApprovaldefault: on

New companies created by agents wait for your approval before they can be ordered against. Turn it off to let agents transact immediately.

commissionsOnOnlineOrdersdefault: off

Include storefront (online) orders in commission calculations, not just agent-placed orders. Leave off to commission agent activity only.

agentDiscountMaxPercentdefault: 0

The ceiling under which an agent's discount auto-applies. Anything above this percentage goes to approval instead. See Discounts & approvals.

managerOrderAttributionteam_agent or manager_only

When a manager orders for a subordinate's company, choose whether the order credits the subordinate (team_agent) or the manager (manager_only).

Territory

territoryEnableddefault: off

Filter each agent's company list to the locations that match their territory. Turn it on to scope who sees which accounts. Full detail in Territories & geo.

Customer app

buyerPortalEnableddefault: off

Turn on the white-label self-service portal so buyers can browse, reorder and track without an agent. See Customer app.

Payment terms

Terms come from your Shopify payment-terms templates: NET 7, 14, 30, 60, 90 and fixed. You can give each a custom display label, for example show "NET 30" as "2/10 Net 30", so buyers see the wording you use in your own paperwork.

Custom fields

Define extra fields to capture on companies or at checkout. Company fields are stored as company metafields under the soryk_custom namespace; checkout fields are stamped onto the draft order. Available types are text, multiline, number, select, boolean and date. Fields are reorderable and each can carry a required flag.

Visit forms

Build the form your agents fill on a customer visit. Fields can be text, multiline, select, date, file, boolean or number; reorder them, and enable or disable the form as a whole. Visit Forms is a Starter add-on and is included on Pro and Scale. See Visits & reports.

Branding

Give the agent and customer apps your look. Upload your logo (stored in Shopify Files), set a brand colour and a buyer accent colour, and override the "from" name and address on transactional emails. A master toggle turns branding on once you're happy with it.

Branding is included on Pro and Scale, or available as the Custom Branding (light) add-on from Growth. See Plans, billing & add-ons.