Catalog
Search catalog variants
Search Shopify product variants and return variant IDs, cursors, and page info.
Search catalog variants
curl --request GET \
--url https://app.pricepirate.com/api/v1/catalog/variants \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.pricepirate.com/api/v1/catalog/variants"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.pricepirate.com/api/v1/catalog/variants', 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.pricepirate.com/api/v1/catalog/variants",
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.pricepirate.com/api/v1/catalog/variants"
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))
}HttpResponse<String> response = Unirest.get("https://app.pricepirate.com/api/v1/catalog/variants")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.pricepirate.com/api/v1/catalog/variants")
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{
"variants": [
{
"id": "gid://shopify/ProductVariant/1001",
"displayName": "Example Product - Black",
"cursor": "eyJsYXN0X2lkIjoxMDAxfQ=="
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "eyJsYXN0X2lkIjoxMDAxfQ=="
},
"variantIds": [
"gid://shopify/ProductVariant/1001"
]
}{
"error": {
"code": "BAD_REQUEST",
"message": "JSON body must be an object",
"details": "Validation details may be included for invalid inputs.",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Missing or invalid Authorization header",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Forbidden",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "TOO_MANY_REQUESTS",
"message": "Rate limit exceeded",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}Authorizations
Public API token passed as Authorization: Bearer .
Query Parameters
Search text matched against Shopify product titles.
Shopify product variant sort key. Values are case-insensitive at runtime.
Available options:
FULL_TITLE, ID, INVENTORY_LEVELS_AVAILABLE, INVENTORY_MANAGEMENT, INVENTORY_POLICY, INVENTORY_QUANTITY, NAME, POPULAR, POSITION, RELEVANCE, SKU, TITLE Maximum number of variants to return.
Required range:
x >= 1Cursor returned by a previous page.
Was this page helpful?
⌘I
Search catalog variants
curl --request GET \
--url https://app.pricepirate.com/api/v1/catalog/variants \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.pricepirate.com/api/v1/catalog/variants"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.pricepirate.com/api/v1/catalog/variants', 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.pricepirate.com/api/v1/catalog/variants",
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.pricepirate.com/api/v1/catalog/variants"
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))
}HttpResponse<String> response = Unirest.get("https://app.pricepirate.com/api/v1/catalog/variants")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.pricepirate.com/api/v1/catalog/variants")
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{
"variants": [
{
"id": "gid://shopify/ProductVariant/1001",
"displayName": "Example Product - Black",
"cursor": "eyJsYXN0X2lkIjoxMDAxfQ=="
}
],
"pageInfo": {
"hasNextPage": false,
"endCursor": "eyJsYXN0X2lkIjoxMDAxfQ=="
},
"variantIds": [
"gid://shopify/ProductVariant/1001"
]
}{
"error": {
"code": "BAD_REQUEST",
"message": "JSON body must be an object",
"details": "Validation details may be included for invalid inputs.",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Missing or invalid Authorization header",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Forbidden",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "TOO_MANY_REQUESTS",
"message": "Rate limit exceeded",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"requestId": "1b11c2c2-7c6f-44d9-9980-02a77681b91f"
}
}