Skip to main content
POST
/
api
/
commerce
/
catalog
/
search
Search catalog products
curl --request POST \
  --url https://app.vaultgraph.com/api/commerce/catalog/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "query": "<string>",
  "filters": {
    "categories": [
      "<string>"
    ],
    "price": {
      "min": 123,
      "max": 123
    }
  },
  "pagination": {
    "cursor": "<string>",
    "limit": 50
  }
}
'
{
  "data": {
    "products": [
      {
        "id": "<string>",
        "handle": "<string>",
        "title": "<string>",
        "media": [
          {
            "type": "<string>",
            "url": "<string>",
            "alt_text": "<string>",
            "width": 123,
            "height": 123
          }
        ],
        "categories": [
          "<string>"
        ],
        "price_range": {
          "min": {
            "amount": 123,
            "currency": "<string>"
          },
          "max": {
            "amount": 123,
            "currency": "<string>"
          }
        },
        "variants": [
          {
            "id": "<string>",
            "product_id": "<string>",
            "title": "<string>",
            "price": {
              "amount": 123,
              "currency": "<string>"
            },
            "availability": {
              "available": true
            },
            "sku": "<string>",
            "list_price": {
              "amount": 123,
              "currency": "<string>"
            }
          }
        ],
        "description": "<string>",
        "list_price_range": {
          "min": {
            "amount": 123,
            "currency": "<string>"
          },
          "max": {
            "amount": 123,
            "currency": "<string>"
          }
        }
      }
    ],
    "pagination": {
      "has_next_page": true,
      "cursor": "<string>",
      "total_count": 123
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.vaultgraph.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-api-key
string
header
required

Body

application/json

Search criteria. Every field is optional — an empty body returns the first page of the whole catalog.

Catalog search criteria. Every field is optional.

query
string

Free-text search query.

filters
object
pagination
object

Response

One page of products, with optional next-page pagination

data
object