Skip to main content
POST
/
store
/
items
/
search
Search Store Items
curl --request POST \
  --url https://api.example.com/store/items/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "namespace_prefix": [
    "<string>"
  ],
  "filter": {},
  "query": "<string>",
  "limit": 20,
  "offset": 0
}
'
import requests

url = "https://api.example.com/store/items/search"

payload = {
    "namespace_prefix": ["<string>"],
    "filter": {},
    "query": "<string>",
    "limit": 20,
    "offset": 0
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    namespace_prefix: ['<string>'],
    filter: {},
    query: '<string>',
    limit: 20,
    offset: 0
  })
};

fetch('https://api.example.com/store/items/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/store/items/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'namespace_prefix' => [
        '<string>'
    ],
    'filter' => [
        
    ],
    'query' => '<string>',
    'limit' => 20,
    'offset' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/store/items/search"

	payload := strings.NewReader("{\n  \"namespace_prefix\": [\n    \"<string>\"\n  ],\n  \"filter\": {},\n  \"query\": \"<string>\",\n  \"limit\": 20,\n  \"offset\": 0\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/store/items/search")
  .header("Content-Type", "application/json")
  .body("{\n  \"namespace_prefix\": [\n    \"<string>\"\n  ],\n  \"filter\": {},\n  \"query\": \"<string>\",\n  \"limit\": 20,\n  \"offset\": 0\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/store/items/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"namespace_prefix\": [\n    \"<string>\"\n  ],\n  \"filter\": {},\n  \"query\": \"<string>\",\n  \"limit\": 20,\n  \"offset\": 0\n}"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "key": "<string>",
      "value": "<unknown>",
      "namespace": [
        "<string>"
      ]
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Body

application/json

Request model for searching store items

namespace_prefix
string[]
required

Namespace prefix to search

filter
Filter · object | null

Optional dictionary of key-value pairs to filter results.

query
string | null

Search query

limit
integer | null
default:20

Maximum results

Required range: 1 <= x <= 100
offset
integer | null
default:0

Results offset

Required range: x >= 0

Response

Successful Response

Response model for store search

items
StoreItem · object[]
required
total
integer
required
limit
integer
required
offset
integer
required