Skip to main content
The inventory ranking sessions endpoint lets you fetch additional pages of ranked products from an ongoing shopping session. Use the pagination metadata returned in a chat response to load subsequent pages without repeating the search.

Endpoint

GET /inventory/ranking-sessions/{conversation_id}/{ranking_session_id}/pages/{page_index}
No authentication required.

Path Parameters

conversation_id
string
required
The conversation session ID. Found in the pagination.conversation_id field of a chat response.
ranking_session_id
string
required
The ranking session identifier. Found in the pagination.session_id field of a chat response.
page_index
integer
required
The page index to retrieve (0-based). Found in pagination.next_page_index.

Example Request

curl "https://rewardsbot-prod.liquidrewardsapi.com/inventory/ranking-sessions/session-abc123/rank-session-xyz/pages/1"

Response (InventoryPaginationResponse)

type
string
Always "inventory_pagination".
conversation_id
string
The conversation ID.
session_id
string
The ranking session ID.
query
string
The original search query.
page_index
integer
The current page index.
page_size
integer
Number of items on this page.
has_next_page
boolean
Whether more pages exist.
expires_at
string | null
Expiry timestamp for this session.
items
InventoryPaginationItem[]
Array of ranked product items.

Error Responses

StatusDescription
422 Unprocessable EntityValidation error
The ranking session expires after the expires_at time. Store expires_at in your UI state to gracefully handle expired sessions.