Skip to main content

Get Home Page

GET 
/api/portal/home

Get the signed-in buyer's Home page.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

  • announcements: the merchant's live announcements (at most 3, in the merchant's order). body_html is the Markdown body rendered to sanitised HTML. Use id + updated_at to remember a dismissal; pinned ones cannot be dismissed.
  • stats: open_orders (not shipped, complete or cancelled), quotes_awaiting (sent and not yet accepted, declined or expired), approvals_waiting (orders waiting on this buyer's approval) and outstanding_balance (amount, currency, overdue_count). A null stat does not apply to this buyer — for example approvals_waiting when the buyer cannot approve, or outstanding_balance when the account has never been invoiced. 0 means it applies and is empty.
  • featured: the section title and the featured products this buyer's catalogs include, in the merchant's order, each in the same shape and at the same price as List Catalog Products. Products outside the buyer's catalogs or archived are left out.
  • recent_orders: the last 3 orders with buyer-facing status; can_reorder is false for read-only buyers.
  • saved_lists: the 3 most recently updated saved lists with their line_count.

Each section is loaded independently: if one fails it is returned as null and the rest still load. An account in preview gets announcements, featured products and quotes only — recent_orders and saved_lists are empty and the other stats are null.

Requires a portal buyer bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type