Search products (preview)

Search products

curl --request GET \
  --url https://app.vortexiq.ai/api/v1/catalog/products/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.vortexiq.ai/api/v1/catalog/products/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://app.vortexiq.ai/api/v1/catalog/products/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.vortexiq.ai/api/v1/catalog/products/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.vortexiq.ai/api/v1/catalog/products/search")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "products": [
    {
      "id": "bc_3kgh3kz_1234",
      "merchant": {
        "id": "m_7f3c2a",
        "name": "Example Outdoor Co",
        "domain": "www.example-outdoor.com",
        "platform": "bigcommerce",
        "currency": "GBP"
      },
      "title": "Trail Runner 2 Waterproof Boot",
      "price": {
        "amount": "49.99",
        "currency": "GBP"
      },
      "availability": "in_stock",
      "url": "https://www.example-outdoor.com/trail-runner-2/",
      "description": "<string>",
      "brand": "<string>",
      "categories": [
        "Footwear",
        "Walking Boots"
      ],
      "sale_price": {
        "amount": "49.99",
        "currency": "GBP"
      },
      "image_url": "<string>",
      "sku": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>"
}

{
  "error": "invalid_request",
  "error_description": "<string>"
}

{
  "error": "invalid_request",
  "error_description": "<string>"
}

{
  "error": "invalid_request",
  "error_description": "<string>"
}

Search products

curl --request GET \
  --url https://app.vortexiq.ai/api/v1/catalog/products/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.vortexiq.ai/api/v1/catalog/products/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://app.vortexiq.ai/api/v1/catalog/products/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.vortexiq.ai/api/v1/catalog/products/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.vortexiq.ai/api/v1/catalog/products/search")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "products": [
    {
      "id": "bc_3kgh3kz_1234",
      "merchant": {
        "id": "m_7f3c2a",
        "name": "Example Outdoor Co",
        "domain": "www.example-outdoor.com",
        "platform": "bigcommerce",
        "currency": "GBP"
      },
      "title": "Trail Runner 2 Waterproof Boot",
      "price": {
        "amount": "49.99",
        "currency": "GBP"
      },
      "availability": "in_stock",
      "url": "https://www.example-outdoor.com/trail-runner-2/",
      "description": "<string>",
      "brand": "<string>",
      "categories": [
        "Footwear",
        "Walking Boots"
      ],
      "sale_price": {
        "amount": "49.99",
        "currency": "GBP"
      },
      "image_url": "<string>",
      "sku": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>"
}

{
  "error": "invalid_request",
  "error_description": "<string>"
}

{
  "error": "invalid_request",
  "error_description": "<string>"
}

{
  "error": "invalid_request",
  "error_description": "<string>"
}

Preview: in development, not yet live.

Authorizations

Authorization

string

header

required

A bearer token issued to approved partners such as Meta, sent as Authorization: Bearer <token>. Partner credentials are issued during onboarding; shoppers never sign in.

Query Parameters

string

required

What the shopper is looking for.

Required string length: 2 - 200

merchant

string

Limit to one merchant id from List merchants.

Response

Matching products.

products

object[]

required

Show child attributes

next_cursor

string | null

required

Pass as cursor for the next page; null on the last page.

All Connectors

Connector Capabilities

Claude MCP Connector

Meta AI Connector

E-commerce Platforms

Advertising

Payments

Authorizations

Query Parameters

Response