Add Tracked Products
curl --request POST \
--url https://server.promptwatch.com/api/v2/shopping/tracked-products \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"products": [
{
"externalProductId": "<string>",
"name": "<string>",
"description": "<string>"
}
]
}
'import requests
url = "https://server.promptwatch.com/api/v2/shopping/tracked-products"
payload = { "products": [
{
"externalProductId": "<string>",
"name": "<string>",
"description": "<string>"
}
] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
products: [{externalProductId: '<string>', name: '<string>', description: '<string>'}]
})
};
fetch('https://server.promptwatch.com/api/v2/shopping/tracked-products', 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://server.promptwatch.com/api/v2/shopping/tracked-products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'products' => [
[
'externalProductId' => '<string>',
'name' => '<string>',
'description' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://server.promptwatch.com/api/v2/shopping/tracked-products"
payload := strings.NewReader("{\n \"products\": [\n {\n \"externalProductId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://server.promptwatch.com/api/v2/shopping/tracked-products")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"products\": [\n {\n \"externalProductId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.promptwatch.com/api/v2/shopping/tracked-products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"products\": [\n {\n \"externalProductId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"created": 123,
"reactivated": 123,
"matched": 123,
"duplicateInBatch": 123,
"duplicateExisting": 123,
"submitted": 123
}{
"error": "Bad Request",
"code": "DATE_RANGE_TOO_LARGE",
"message": "Date range cannot exceed 90 days"
}{
"error": "Unauthorized",
"message": "Missing or invalid X-API-Key header."
}{
"code": "SHOPPING_INSIGHTS_PLAN_REQUIRED",
"message": "Shopping insights are not available on your current plan"
}{
"code": "SHOPPING_INSIGHTS_PLAN_REQUIRED",
"message": "Shopping insights are not available on your current plan"
}Shopping
Add Tracked Products
Track one or more products; duplicates are counted and skipped instead of failing the request
POST
/
shopping
/
tracked-products
Add Tracked Products
curl --request POST \
--url https://server.promptwatch.com/api/v2/shopping/tracked-products \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"products": [
{
"externalProductId": "<string>",
"name": "<string>",
"description": "<string>"
}
]
}
'import requests
url = "https://server.promptwatch.com/api/v2/shopping/tracked-products"
payload = { "products": [
{
"externalProductId": "<string>",
"name": "<string>",
"description": "<string>"
}
] }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
products: [{externalProductId: '<string>', name: '<string>', description: '<string>'}]
})
};
fetch('https://server.promptwatch.com/api/v2/shopping/tracked-products', 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://server.promptwatch.com/api/v2/shopping/tracked-products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'products' => [
[
'externalProductId' => '<string>',
'name' => '<string>',
'description' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://server.promptwatch.com/api/v2/shopping/tracked-products"
payload := strings.NewReader("{\n \"products\": [\n {\n \"externalProductId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://server.promptwatch.com/api/v2/shopping/tracked-products")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"products\": [\n {\n \"externalProductId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.promptwatch.com/api/v2/shopping/tracked-products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"products\": [\n {\n \"externalProductId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"created": 123,
"reactivated": 123,
"matched": 123,
"duplicateInBatch": 123,
"duplicateExisting": 123,
"submitted": 123
}{
"error": "Bad Request",
"code": "DATE_RANGE_TOO_LARGE",
"message": "Date range cannot exceed 90 days"
}{
"error": "Unauthorized",
"message": "Missing or invalid X-API-Key header."
}{
"code": "SHOPPING_INSIGHTS_PLAN_REQUIRED",
"message": "Shopping insights are not available on your current plan"
}{
"code": "SHOPPING_INSIGHTS_PLAN_REQUIRED",
"message": "Shopping insights are not available on your current plan"
}Authorizations
API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.
Body
application/json
Products to track; duplicates are skipped, not rejected
Required array length:
1 - 5000 elementsShow child attributes
Show child attributes
Response
Default Response
Newly created tracked products
Previously deleted tracked products restored
Products matched to an already-extracted shopping item
Rows skipped as duplicates within the request
Rows skipped because the product is already tracked
Rows submitted in the request
⌘I