Create or update a catalog product by your product ID
curl --request PUT \
--url http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"price": "19.90",
"productUrl": "<string>",
"description": "<string>",
"status": "active",
"compareAtPrice": "<string>",
"imageUrl": "<string>",
"category": "<string>",
"tags": [],
"sku": "<string>"
}
'import requests
url = "http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}"
payload = {
"title": "<string>",
"price": "19.90",
"productUrl": "<string>",
"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.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
price: '19.90',
productUrl: '<string>',
description: '<string>',
status: 'active',
compareAtPrice: '<string>',
imageUrl: '<string>',
category: '<string>',
tags: [],
sku: '<string>'
})
};
fetch('http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}', 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/by-external-id/{externalId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'price' => '19.90',
'productUrl' => '<string>',
'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/by-external-id/{externalId}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"price\": \"19.90\",\n \"productUrl\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"active\",\n \"compareAtPrice\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"tags\": [],\n \"sku\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"price\": \"19.90\",\n \"productUrl\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"active\",\n \"compareAtPrice\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"tags\": [],\n \"sku\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"price\": \"19.90\",\n \"productUrl\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"active\",\n \"compareAtPrice\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"tags\": [],\n \"sku\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"outcome": "created",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"source": "shopify",
"status": "active",
"title": "<string>",
"handle": "<string>",
"description": "<string>",
"price": "<string>",
"compareAtPrice": "<string>",
"currency": "<string>",
"primaryImageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primaryImageUrl": "<string>",
"primaryImageExternalId": "<string>",
"primaryImageAltText": "<string>",
"primaryImageIssue": {
"code": "size_exceeded",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"sourceUrl": "<string>",
"details": {}
},
"imageIds": [
"<string>"
],
"galleryImages": [
{
"externalId": "<string>",
"url": "<string>",
"altText": "<string>",
"position": 4503599627370495
}
],
"productUrl": "<string>",
"category": "<string>",
"tags": [
"<string>"
],
"sku": "<string>",
"vendor": "<string>",
"featured": true,
"lastSyncedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"success": true,
"outcome": "created",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"source": "shopify",
"status": "active",
"title": "<string>",
"handle": "<string>",
"description": "<string>",
"price": "<string>",
"compareAtPrice": "<string>",
"currency": "<string>",
"primaryImageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primaryImageUrl": "<string>",
"primaryImageExternalId": "<string>",
"primaryImageAltText": "<string>",
"primaryImageIssue": {
"code": "size_exceeded",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"sourceUrl": "<string>",
"details": {}
},
"imageIds": [
"<string>"
],
"galleryImages": [
{
"externalId": "<string>",
"url": "<string>",
"altText": "<string>",
"position": 4503599627370495
}
],
"productUrl": "<string>",
"category": "<string>",
"tags": [
"<string>"
],
"sku": "<string>",
"vendor": "<string>",
"featured": true,
"lastSyncedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"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 a catalog product by your product ID
Creates the product, or replaces its fields when a product with this ID already exists. Fields you leave out are cleared, except status, which becomes active. 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.
PUT
/
api
/
v1
/
catalog-products
/
by-external-id
/
{externalId}
Create or update a catalog product by your product ID
curl --request PUT \
--url http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"title": "<string>",
"price": "19.90",
"productUrl": "<string>",
"description": "<string>",
"status": "active",
"compareAtPrice": "<string>",
"imageUrl": "<string>",
"category": "<string>",
"tags": [],
"sku": "<string>"
}
'import requests
url = "http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}"
payload = {
"title": "<string>",
"price": "19.90",
"productUrl": "<string>",
"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.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
price: '19.90',
productUrl: '<string>',
description: '<string>',
status: 'active',
compareAtPrice: '<string>',
imageUrl: '<string>',
category: '<string>',
tags: [],
sku: '<string>'
})
};
fetch('http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}', 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/by-external-id/{externalId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'price' => '19.90',
'productUrl' => '<string>',
'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/by-external-id/{externalId}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"price\": \"19.90\",\n \"productUrl\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"active\",\n \"compareAtPrice\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"tags\": [],\n \"sku\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"price\": \"19.90\",\n \"productUrl\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"active\",\n \"compareAtPrice\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"tags\": [],\n \"sku\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"price\": \"19.90\",\n \"productUrl\": \"<string>\",\n \"description\": \"<string>\",\n \"status\": \"active\",\n \"compareAtPrice\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"category\": \"<string>\",\n \"tags\": [],\n \"sku\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"outcome": "created",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"source": "shopify",
"status": "active",
"title": "<string>",
"handle": "<string>",
"description": "<string>",
"price": "<string>",
"compareAtPrice": "<string>",
"currency": "<string>",
"primaryImageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primaryImageUrl": "<string>",
"primaryImageExternalId": "<string>",
"primaryImageAltText": "<string>",
"primaryImageIssue": {
"code": "size_exceeded",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"sourceUrl": "<string>",
"details": {}
},
"imageIds": [
"<string>"
],
"galleryImages": [
{
"externalId": "<string>",
"url": "<string>",
"altText": "<string>",
"position": 4503599627370495
}
],
"productUrl": "<string>",
"category": "<string>",
"tags": [
"<string>"
],
"sku": "<string>",
"vendor": "<string>",
"featured": true,
"lastSyncedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"success": true,
"outcome": "created",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>",
"source": "shopify",
"status": "active",
"title": "<string>",
"handle": "<string>",
"description": "<string>",
"price": "<string>",
"compareAtPrice": "<string>",
"currency": "<string>",
"primaryImageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primaryImageUrl": "<string>",
"primaryImageExternalId": "<string>",
"primaryImageAltText": "<string>",
"primaryImageIssue": {
"code": "size_exceeded",
"message": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"sourceUrl": "<string>",
"details": {}
},
"imageIds": [
"<string>"
],
"galleryImages": [
{
"externalId": "<string>",
"url": "<string>",
"altText": "<string>",
"position": 4503599627370495
}
],
"productUrl": "<string>",
"category": "<string>",
"tags": [
"<string>"
],
"sku": "<string>",
"vendor": "<string>",
"featured": true,
"lastSyncedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"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
}
}Path Parameters
Body
application/json

