Skip to main content

Get Page Guides

GET 

/api/portal/page-guides

Get the help guides for one portal screen: the guides written for buyers that cover it and apply to this account, most useful first (a how-to with steps leads).

Buyer portal token

Called by a B2B portal buyer with the bearer token POST /api/portal/auth/login returns (or the buyer's feed key) — not with a staff Personal Access Token.

A guide is left out when the account does not have what it is about switched on — for example the dropship guides when dropship is off, or the CSV upload guide when the supplier does not accept CSV uploads.

Each guide carries its title, description, type (how-to, concept, reference, overview), before_you_begin bullets, numbered steps (UI names are marked with **bold**; target names the control a step points at, or null), steps_heading, read_minutes, last_verified (Y-m-d) and in_feed (false when only the title and link are known).

links_allowed says whether the merchant lets help link to the full guides on www.sku.io. When false, no guide carries a video, related guides or headings, and closest is empty — show the summary and steps only. When true, video (youtube_id, duration, duration_seconds) is set for guides with a walkthrough, and closest lists nearby guides when none covers the screen.

matched_path is null when no guide covers the screen. feed_available is false when the guide content could not be loaded (guides then have in_feed false); feed_stale is true when a cached copy is being served.

Available to every portal role, including Viewer. Requires a portal buyer bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type