Get NuORDER Dashboard
GET/api/nuorder/instances/:integrationInstance/dashboard
Returns an overview of one NuORDER instance: connection state (including the OAuth auth_state and whether it talks to a simulated portal), record counts, wholesale order value, per-entity sync health, the automatic sync schedule (orders every 15 minutes, products daily, inventory every minute, shipments when a fulfillment is created), the latest order and order/product/inventory/shipment KPIs.
integrations:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Query parameters:
period(string, optional) — Revenue window:today,7d, or30d. Omit for all time.
Response highlights:
financial_summary— order value of non-cancelled orders placed in NuORDER in the window. NuORDER takes no marketplace fee and has no refunds, sonet_revenue=gross_revenue.currencyis the instance's most common order currency (ornull).sync_summary.entities.*.is_stale— a sync that has never run is stale only once the connection is older than the stale window, so a new connection does not read unhealthy.sync_summary.overall_health— computed from the foursync_healthtypes (orders, products, inventory, tracking); a type in stateneveris not counted, andok/runningcount as healthy.statusisexcellent(90%+),fair(50%+),critical,unknown(connected, but no sync has run yet; 0 of 0, 0%) ornot connected(the portal is not authorized; 0 of 0, 0%).sync_summary.auto_sync.schedules.*—cadence,interval_seconds,seconds_until_nextandnext_run_at(bothnullwhen inactive) andinactive_reason(e.g.Runs in production,Paused in settings).inventory_setup_needed(boolean) — true when the portal is connected, has NuORDER warehouses, and none of them receives stock from SKU.io yet (no location hasmasterOfStock: sku.iowith a stock warehouse chosen). The dashboard uses it to prompt for Settings → Inventory.sync_health.{orders|products|inventory|tracking}.state—ok,running,failing(a failure newer than the last success;last_errorsays why) ornever.kpis.orders—total,linked(has a SKU.io sales order),awaiting_sales_order(andawaiting_sales_order_statuses, the statuses that count covers, set by the create-orders-at setting),in_review,cancelled,shipped(archived orders excluded).kpis.productssize counts exclude archived sizes.kpis.tracking—last_submitted_at,submitted_last_24h,failed_last_24h,cancellations_sent_last_24h.
Authentication: Bearer token (Personal Access Token).
connection.auth_state_label is the connection state as the portal's banner and Settings → Authentication word it (Connected, Awaiting keys, Awaiting approval).
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not Found
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.