Needs the read scope.
Pages its answer: pass the cursor back for the next page, at most 100 items a page.
Sorts: value.
Searches value. An empty page with a cursor means nothing so far: only a null cursor ends a search. A searched page past the count budget comes back without its total and facets, which never means zero.
Call
- Tool:
list_entry_sections - Scope:
read - Reads only.
- Acts on a store.
Arguments
| Name | Type | Required | Description |
|---|---|---|---|
product |
object |
Yes | |
query |
object |
No | |
preview |
string |
No | A token a seller made for the product’s page or one of its entries, which lists an unpublished product’s values. |
{
"type": "object",
"properties": {
"product": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"id"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"required": [
"slug"
],
"additionalProperties": false
}
]
},
"query": {
"type": "object",
"properties": {
"filter": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"sort": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"value"
]
},
"direction": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"additionalProperties": false
},
"search": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"cursor": {
"type": "string",
"maxLength": 8192
},
"count": {
"type": "boolean"
}
},
"additionalProperties": false
},
"preview": {
"description": "A token a seller made for the product's page or one of its entries, which lists an unpublished product's values.",
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"product"
],
"additionalProperties": false
}Answer
| Name | Type | Required | Description |
|---|---|---|---|
items |
array of object |
Yes | |
cursor |
string or null |
Yes | |
total |
number |
No | |
facets |
object |
No |
The answer’s full shape is on its API reference page.