Create or update catalog products in a batch
curl --request POST \
--url http://localhost:3001/api/v1/catalog-products/batch \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"products": [
{
"title": "<string>",
"price": "19.90",
"productUrl": "<string>",
"externalId": "8812345",
"description": "<string>",
"status": "active",
"compareAtPrice": "<string>",
"imageUrl": "<string>",
"category": "<string>",
"tags": [],
"sku": "<string>"
}
]
}
'import requests
url = "http://localhost:3001/api/v1/catalog-products/batch"
payload = { "products": [
{
"title": "<string>",
"price": "19.90",
"productUrl": "<string>",
"externalId": "8812345",
"description": "<string>",
"status": "active",
"compareAtPrice": "<string>",
"imageUrl": "<string>",
"category": "<string>",
"tags": [],
"sku": "<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: [
{
title: '<string>',
price: '19.90',
productUrl: '<string>',
externalId: '8812345',
description: '<string>',
status: 'active',
compareAtPrice: '<string>',
imageUrl: '<string>',
category: '<string>',
tags: [],
sku: '<string>'
}
]
})
};
fetch('http://localhost:3001/api/v1/catalog-products/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/catalog-products/batch",
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' => [
[
'title' => '<string>',
'price' => '19.90',
'productUrl' => '<string>',
'externalId' => '8812345',
'description' => '<string>',
'status' => 'active',
'compareAtPrice' => '<string>',
'imageUrl' => '<string>',
'category' => '<string>',
'tags' => [
],
'sku' => '<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 := "http://localhost:3001/api/v1/catalog-products/batch"
payload := strings.NewReader("{\n \"products\": [\n {\n \"title\": \"<string>\",\n \"price\": \"19.90\",\n \"productUrl\": \"<string>\",\n \"externalId\": \"8812345\",\n \"description\": \"<string>\",\n \"status\": \"active\",\n \"compareAtPrice\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"tags\": [],\n \"sku\": \"<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("http://localhost:3001/api/v1/catalog-products/batch")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"products\": [\n {\n \"title\": \"<string>\",\n \"price\": \"19.90\",\n \"productUrl\": \"<string>\",\n \"externalId\": \"8812345\",\n \"description\": \"<string>\",\n \"status\": \"active\",\n \"compareAtPrice\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"tags\": [],\n \"sku\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/catalog-products/batch")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"products\": [\n {\n \"title\": \"<string>\",\n \"price\": \"19.90\",\n \"productUrl\": \"<string>\",\n \"externalId\": \"8812345\",\n \"description\": \"<string>\",\n \"status\": \"active\",\n \"compareAtPrice\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"tags\": [],\n \"sku\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"created": 4503599627370495,
"updated": 4503599627370495,
"results": [
{
"externalId": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "created"
}
]
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 12 seconds.",
"details": {
"retryAfterSeconds": 12
}
}Catalog-Products
Create or update catalog products in a batch
Creates or updates up to 100 products by your product IDs. The batch is saved as a whole: when one product is invalid, none are saved. Products are keyed by your store’s own product ID within the API source, so sending the same ID again updates the product instead of adding another. Retries are safe.
POST
/
api
/
v1
/
catalog-products
/
batch
Create or update catalog products in a batch
curl --request POST \
--url http://localhost:3001/api/v1/catalog-products/batch \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"products": [
{
"title": "<string>",
"price": "19.90",
"productUrl": "<string>",
"externalId": "8812345",
"description": "<string>",
"status": "active",
"compareAtPrice": "<string>",
"imageUrl": "<string>",
"category": "<string>",
"tags": [],
"sku": "<string>"
}
]
}
'import requests
url = "http://localhost:3001/api/v1/catalog-products/batch"
payload = { "products": [
{
"title": "<string>",
"price": "19.90",
"productUrl": "<string>",
"externalId": "8812345",
"description": "<string>",
"status": "active",
"compareAtPrice": "<string>",
"imageUrl": "<string>",
"category": "<string>",
"tags": [],
"sku": "<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: [
{
title: '<string>',
price: '19.90',
productUrl: '<string>',
externalId: '8812345',
description: '<string>',
status: 'active',
compareAtPrice: '<string>',
imageUrl: '<string>',
category: '<string>',
tags: [],
sku: '<string>'
}
]
})
};
fetch('http://localhost:3001/api/v1/catalog-products/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/v1/catalog-products/batch",
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' => [
[
'title' => '<string>',
'price' => '19.90',
'productUrl' => '<string>',
'externalId' => '8812345',
'description' => '<string>',
'status' => 'active',
'compareAtPrice' => '<string>',
'imageUrl' => '<string>',
'category' => '<string>',
'tags' => [
],
'sku' => '<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 := "http://localhost:3001/api/v1/catalog-products/batch"
payload := strings.NewReader("{\n \"products\": [\n {\n \"title\": \"<string>\",\n \"price\": \"19.90\",\n \"productUrl\": \"<string>\",\n \"externalId\": \"8812345\",\n \"description\": \"<string>\",\n \"status\": \"active\",\n \"compareAtPrice\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"tags\": [],\n \"sku\": \"<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("http://localhost:3001/api/v1/catalog-products/batch")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"products\": [\n {\n \"title\": \"<string>\",\n \"price\": \"19.90\",\n \"productUrl\": \"<string>\",\n \"externalId\": \"8812345\",\n \"description\": \"<string>\",\n \"status\": \"active\",\n \"compareAtPrice\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"tags\": [],\n \"sku\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/catalog-products/batch")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"products\": [\n {\n \"title\": \"<string>\",\n \"price\": \"19.90\",\n \"productUrl\": \"<string>\",\n \"externalId\": \"8812345\",\n \"description\": \"<string>\",\n \"status\": \"active\",\n \"compareAtPrice\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"tags\": [],\n \"sku\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"created": 4503599627370495,
"updated": 4503599627370495,
"results": [
{
"externalId": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"outcome": "created"
}
]
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "TEMPLATE_NAME_EXISTS",
"message": "Template name 'Hello' already exists in this organization.",
"details": {
"issues": [
{
"path": "name",
"code": "duplicate",
"message": "Template name already exists in this organization."
}
]
}
}{
"errorCode": "RATE_LIMITED",
"message": "Rate limit exceeded. Retry after 12 seconds.",
"details": {
"retryAfterSeconds": 12
}
}Body
application/json

