Search products

curl --request GET \
  --url https://api.upstackdata.com/accounts/api/products/search \
  --header 'x-api-key: <api-key>' \
  --header 'x-pixel-id: <api-key>'

import requests

url = "https://api.upstackdata.com/accounts/api/products/search"

headers = {
    "x-api-key": "<api-key>",
    "x-pixel-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', 'x-pixel-id': '<api-key>'}};

fetch('https://api.upstackdata.com/accounts/api/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://api.upstackdata.com/accounts/api/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 => [
    "x-api-key: <api-key>",
    "x-pixel-id: <api-key>"
  ],
]);

$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://api.upstackdata.com/accounts/api/products/search"

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-pixel-id", "<api-key>")

	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://api.upstackdata.com/accounts/api/products/search")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-pixel-id"] = '<api-key>'

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

{
  "items": [
    {
      "id": "<string>",
      "title": "<string>",
      "vendor": "<string>",
      "variants": [
        {
          "id": "<string>",
          "productId": "<string>",
          "sku": "<string>",
          "title": "<string>",
          "handlingFee": 123,
          "manualCostHistory": [
            {
              "id": "<string>",
              "cost": 123,
              "effectiveStartDate": "<string>",
              "effectiveEndDate": "<string>",
              "description": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "nextCursor": "<string>"
}

{
  "message": "<string>",
  "errors": [
    {
      "message": "<string>",
      "key": "<string>",
      "path": [
        "<string>"
      ]
    }
  ]
}

{
  "message": "<string>",
  "errors": [
    {
      "message": "<string>",
      "key": "<string>",
      "path": [
        "<string>"
      ]
    }
  ]
}

{
  "message": "<string>",
  "errors": [
    {
      "message": "<string>",
      "key": "<string>",
      "path": [
        "<string>"
      ]
    }
  ]
}

GET

accounts

api

products

Search products

curl --request GET \
  --url https://api.upstackdata.com/accounts/api/products/search \
  --header 'x-api-key: <api-key>' \
  --header 'x-pixel-id: <api-key>'

import requests

url = "https://api.upstackdata.com/accounts/api/products/search"

headers = {
    "x-api-key": "<api-key>",
    "x-pixel-id": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>', 'x-pixel-id': '<api-key>'}};

fetch('https://api.upstackdata.com/accounts/api/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://api.upstackdata.com/accounts/api/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 => [
    "x-api-key: <api-key>",
    "x-pixel-id: <api-key>"
  ],
]);

$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://api.upstackdata.com/accounts/api/products/search"

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

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("x-pixel-id", "<api-key>")

	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://api.upstackdata.com/accounts/api/products/search")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
request["x-pixel-id"] = '<api-key>'

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

{
  "items": [
    {
      "id": "<string>",
      "title": "<string>",
      "vendor": "<string>",
      "variants": [
        {
          "id": "<string>",
          "productId": "<string>",
          "sku": "<string>",
          "title": "<string>",
          "handlingFee": 123,
          "manualCostHistory": [
            {
              "id": "<string>",
              "cost": 123,
              "effectiveStartDate": "<string>",
              "effectiveEndDate": "<string>",
              "description": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "nextCursor": "<string>"
}

{
  "message": "<string>",
  "errors": [
    {
      "message": "<string>",
      "key": "<string>",
      "path": [
        "<string>"
      ]
    }
  ]
}

{
  "message": "<string>",
  "errors": [
    {
      "message": "<string>",
      "key": "<string>",
      "path": [
        "<string>"
      ]
    }
  ]
}

{
  "message": "<string>",
  "errors": [
    {
      "message": "<string>",
      "key": "<string>",
      "path": [
        "<string>"
      ]
    }
  ]
}

Authorizations

x-api-key

string

header

required

Your Upstack API key. Starts with upstack_.

x-pixel-id

string

header

required

The pixel id the request targets.

Query Parameters

string

Search term (matched against title / SKU / variant).

pageSize

integer

default:20

Required range: 1 <= x <= 100

cursor

string

Pagination cursor from a previous response's nextCursor.

Response

A page of products with their variants.

items

object[]

required

Show child attributes

nextCursor

string | null

Cursor to pass as ?cursor= to fetch the next page. null when no more pages.

⌘I

OVERVIEW

ACCOUNT

CATALOG

ANALYTICS

DASHBOARDS

COSTS

PRODUCTS

EVENTS

Search products

Authorizations

Query Parameters

Response