Archive a catalog product by your product ID
curl --request POST \
--url http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}/archive \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}/archive"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}/archive', 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}/archive",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}/archive"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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/by-external-id/{externalId}/archive")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}/archive")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"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
Archive a catalog product by your product ID
Archives a product you sent through the API. Archived products leave the catalog and stop appearing in emails. Archiving an archived product succeeds.
POST
/
api
/
v1
/
catalog-products
/
by-external-id
/
{externalId}
/
archive
Archive a catalog product by your product ID
curl --request POST \
--url http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}/archive \
--header 'x-api-key: <api-key>'import requests
url = "http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}/archive"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}/archive', 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}/archive",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}/archive"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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/by-external-id/{externalId}/archive")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/v1/catalog-products/by-external-id/{externalId}/archive")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"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
}
}
