Supplier Portal and Field Reference
Developer reference for portal routes, account gates, wire names, and lifecycle values. Supplier operators should start with Getting Started or What You Can Use Today.
Portal surface map
| Portal area | Capability |
|---|---|
Dashboard (/) | Operational summary and alerts |
Orders (/orders) | Dropship accept/ship/reject/cancel; wholesale confirm/ship/reject/cancel; seller owns receipt |
Returns (/returns) | Supplier RMA work items |
Catalog (/catalog) | Product management and CSV import/export |
Inventory (/inventory) | Stock, low-stock, incoming stock, and adjustments |
Feeds (/feeds) | Catalog and inventory feed runs |
Sellers (/sellers) | Connections, terms, channel enablement, and credit limits |
Settlements (/settlements) | Payables, ageing, export, and wholesale remittance acknowledgement |
Documents (/documents) | Issued trade-document archive |
Settings (/settings) | Company profile, supports_dropship, supports_wholesale, and system-event delivery settings |
Analytics (/analytics) | Deferred; not available in the launch-visible portal |
Scorecard (/scorecard) | Deferred; not available in the launch-visible portal |
Account and connection fields
Supplier channel gates use supports_dropship and supports_wholesale plus
supplier verification. Seller approval can establish:
agreed_discount_pctcredit_limitpayment_terms_daysdropship_enableddropship_margin_pct
After approval, supplier self-service changes only credit_limit. Other
commercial fields need a new terms agreement or marketplace coordination.
Connection status transitions are:
| From | Allowed next states |
|---|---|
pending | approved or rejected |
approved | suspended or revoked |
suspended | approved or revoked |
rejected / revoked | pending through the permitted reopen path |
Reactivate changes status from suspended to approved; it does not create a
new terms version.
Order and return lifecycle values
Dropship order status values include pending, sent_to_supplier, accepted,
processing, shipped, delivered, and cancelled.
Wholesale purchase-order status values include pending, sent, accepted,
processing, shipped, delivered, and cancelled. Supplier Portal does not
write the wholesale delivered transition; Partner Portal goods receipt owns
that state.
Supplier return actions and outcomes are:
| Action | Accepted current status | Result |
|---|---|---|
accept | requested | accepted |
receive | accepted | received |
credit | accepted or received | credited |
reject | requested, accepted, or received | rejected |
credit requires a non-negative credit_amount.
Catalog, feeds, and settlement fields
- Product retirement uses
is_active=falseandis_discontinued=truerather than deleting marketplace history. - The canonical generic feed profiles expose OKNowShop headers directly.
Source-format profiles may return
needs_mapping: trueandprovisional: true; validate a real source export before depending on a provisional mapping. - Wholesale pricing wires include
cost_price,wholesale_price,minimum_order_qty,commission_amount, andcommission_rate.cost_priceis audit-only and never falls back as the seller-facing wholesale price. - A recorded wholesale remittance projects
paid_atand the payment reference into the settlement ledger after the linked invoice is marked paid.
Business guidance
| Outcome | Start here |
|---|---|
| First go-live | Getting Started |
| Bulk catalog | Feeds |
| Reduce exceptions | Order Operations → Returns |
| Commercial risk | Seller Connections |
| Finance reconcile | Settlements → Documents |
| Bulk data / events | Feeds → Integration guide |