Vendure · Example Payload

Vendure Shop Search Example

Example: faceted search on the Shop API.

CommerceHeadless CommerceE-CommerceGraphQLOpen-SourceTypeScriptNestJSB2BB2CStorefrontPlugins

Vendure Shop Search Example is an example object payload from Vendure, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

descriptionrequestresponse

Example Payload

Raw ↑
{
  "description": "Example: faceted search on the Shop API.",
  "request": {
    "method": "POST",
    "url": "http://localhost:3000/shop-api",
    "headers": { "Content-Type": "application/json" },
    "body": {
      "query": "query Search($input: SearchInput!) { search(input: $input) { totalItems facetValues { count facetValue { id name facet { name } } } items { productId productName slug priceWithTax { ... on PriceRange { min max } ... on SinglePrice { value } } } } }",
      "variables": {
        "input": { "term": "headphones", "take": 10, "groupByProduct": true }
      }
    }
  },
  "response": {
    "status": 200,
    "body": {
      "data": {
        "search": {
          "totalItems": 3,
          "facetValues": [
            { "count": 3, "facetValue": { "id": "1", "name": "Audio", "facet": { "name": "Category" } } }
          ],
          "items": [
            { "productId": "12", "productName": "Wireless Headphones", "slug": "wireless-headphones", "priceWithTax": { "min": 2499, "max": 3999 } }
          ]
        }
      }
    }
  }
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This example
curl "https://apis.io/api/v1/examples/vendure-shop-search-example"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.