Partial update. Omitted fields are left untouched.
curl --request PATCH \
--url https://api.platformdtc.com/api/v1/products/{product_id} \
--header 'Content-Type: application/json' \
--header 'X-Agent-Key: <api-key>' \
--data '
{
"title": "<string>",
"handle": "<string>",
"product_type": "<string>",
"vendor": "<string>",
"price": 1,
"tags": [
"<string>"
],
"options": [
"<string>"
],
"supplier_id": "<string>",
"pdp_template_id": "<string>",
"fulfillment_rules": [
{
"country_codes": [
"<string>"
],
"supplier_id": "<string>"
}
],
"description": "<string>",
"category": "<string>"
}
'import requests
url = "https://api.platformdtc.com/api/v1/products/{product_id}"
payload = {
"title": "<string>",
"handle": "<string>",
"product_type": "<string>",
"vendor": "<string>",
"price": 1,
"tags": ["<string>"],
"options": ["<string>"],
"supplier_id": "<string>",
"pdp_template_id": "<string>",
"fulfillment_rules": [
{
"country_codes": ["<string>"],
"supplier_id": "<string>"
}
],
"description": "<string>",
"category": "<string>"
}
headers = {
"X-Agent-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Agent-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
handle: '<string>',
product_type: '<string>',
vendor: '<string>',
price: 1,
tags: ['<string>'],
options: ['<string>'],
supplier_id: '<string>',
pdp_template_id: '<string>',
fulfillment_rules: [{country_codes: ['<string>'], supplier_id: '<string>'}],
description: '<string>',
category: '<string>'
})
};
fetch('https://api.platformdtc.com/api/v1/products/{product_id}', 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://api.platformdtc.com/api/v1/products/{product_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'handle' => '<string>',
'product_type' => '<string>',
'vendor' => '<string>',
'price' => 1,
'tags' => [
'<string>'
],
'options' => [
'<string>'
],
'supplier_id' => '<string>',
'pdp_template_id' => '<string>',
'fulfillment_rules' => [
[
'country_codes' => [
'<string>'
],
'supplier_id' => '<string>'
]
],
'description' => '<string>',
'category' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Agent-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://api.platformdtc.com/api/v1/products/{product_id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"handle\": \"<string>\",\n \"product_type\": \"<string>\",\n \"vendor\": \"<string>\",\n \"price\": 1,\n \"tags\": [\n \"<string>\"\n ],\n \"options\": [\n \"<string>\"\n ],\n \"supplier_id\": \"<string>\",\n \"pdp_template_id\": \"<string>\",\n \"fulfillment_rules\": [\n {\n \"country_codes\": [\n \"<string>\"\n ],\n \"supplier_id\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"category\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Agent-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.patch("https://api.platformdtc.com/api/v1/products/{product_id}")
.header("X-Agent-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"handle\": \"<string>\",\n \"product_type\": \"<string>\",\n \"vendor\": \"<string>\",\n \"price\": 1,\n \"tags\": [\n \"<string>\"\n ],\n \"options\": [\n \"<string>\"\n ],\n \"supplier_id\": \"<string>\",\n \"pdp_template_id\": \"<string>\",\n \"fulfillment_rules\": [\n {\n \"country_codes\": [\n \"<string>\"\n ],\n \"supplier_id\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"category\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.platformdtc.com/api/v1/products/{product_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Agent-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"handle\": \"<string>\",\n \"product_type\": \"<string>\",\n \"vendor\": \"<string>\",\n \"price\": 1,\n \"tags\": [\n \"<string>\"\n ],\n \"options\": [\n \"<string>\"\n ],\n \"supplier_id\": \"<string>\",\n \"pdp_template_id\": \"<string>\",\n \"fulfillment_rules\": [\n {\n \"country_codes\": [\n \"<string>\"\n ],\n \"supplier_id\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"category\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"merchant_id": "<string>",
"store_id": "<string>",
"title": "<string>",
"handle": "<string>",
"product_type": "<string>",
"vendor": "<string>",
"tags": [
"<string>"
],
"options": [
"<string>"
],
"status": 0,
"status_label": "draft",
"bind_status": 123,
"bind_erp_product_id": "<string>",
"price": 123,
"link": "<string>",
"image_url": "<string>",
"project_id": "<string>",
"supplier_id": "<string>",
"pdp_template_id": "<string>",
"description": "<string>",
"category": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"images": [
{
"id": "<string>",
"url": "<string>",
"width": "<string>",
"height": "<string>"
}
],
"variants": [
{
"id": "<string>",
"product_id": "<string>",
"title": "<string>",
"price": 123,
"sku": "<string>",
"option1": "<string>",
"option2": "<string>",
"option3": "<string>",
"weight": 123,
"weight_unit": "<string>",
"position": 123,
"image_url": "<string>",
"compare_at_price": 123,
"inventory_quantity": 123,
"bind_erp_variant_id": "<string>",
"erp_bundle_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"sales_7_days": "<string>",
"variants_count": 123,
"is_published": true
},
"meta": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}products
Partial update. Omitted fields are left untouched.
PATCH
/
api
/
v1
/
products
/
{product_id}
Partial update. Omitted fields are left untouched.
curl --request PATCH \
--url https://api.platformdtc.com/api/v1/products/{product_id} \
--header 'Content-Type: application/json' \
--header 'X-Agent-Key: <api-key>' \
--data '
{
"title": "<string>",
"handle": "<string>",
"product_type": "<string>",
"vendor": "<string>",
"price": 1,
"tags": [
"<string>"
],
"options": [
"<string>"
],
"supplier_id": "<string>",
"pdp_template_id": "<string>",
"fulfillment_rules": [
{
"country_codes": [
"<string>"
],
"supplier_id": "<string>"
}
],
"description": "<string>",
"category": "<string>"
}
'import requests
url = "https://api.platformdtc.com/api/v1/products/{product_id}"
payload = {
"title": "<string>",
"handle": "<string>",
"product_type": "<string>",
"vendor": "<string>",
"price": 1,
"tags": ["<string>"],
"options": ["<string>"],
"supplier_id": "<string>",
"pdp_template_id": "<string>",
"fulfillment_rules": [
{
"country_codes": ["<string>"],
"supplier_id": "<string>"
}
],
"description": "<string>",
"category": "<string>"
}
headers = {
"X-Agent-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-Agent-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
handle: '<string>',
product_type: '<string>',
vendor: '<string>',
price: 1,
tags: ['<string>'],
options: ['<string>'],
supplier_id: '<string>',
pdp_template_id: '<string>',
fulfillment_rules: [{country_codes: ['<string>'], supplier_id: '<string>'}],
description: '<string>',
category: '<string>'
})
};
fetch('https://api.platformdtc.com/api/v1/products/{product_id}', 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://api.platformdtc.com/api/v1/products/{product_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'handle' => '<string>',
'product_type' => '<string>',
'vendor' => '<string>',
'price' => 1,
'tags' => [
'<string>'
],
'options' => [
'<string>'
],
'supplier_id' => '<string>',
'pdp_template_id' => '<string>',
'fulfillment_rules' => [
[
'country_codes' => [
'<string>'
],
'supplier_id' => '<string>'
]
],
'description' => '<string>',
'category' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Agent-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://api.platformdtc.com/api/v1/products/{product_id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"handle\": \"<string>\",\n \"product_type\": \"<string>\",\n \"vendor\": \"<string>\",\n \"price\": 1,\n \"tags\": [\n \"<string>\"\n ],\n \"options\": [\n \"<string>\"\n ],\n \"supplier_id\": \"<string>\",\n \"pdp_template_id\": \"<string>\",\n \"fulfillment_rules\": [\n {\n \"country_codes\": [\n \"<string>\"\n ],\n \"supplier_id\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"category\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-Agent-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.patch("https://api.platformdtc.com/api/v1/products/{product_id}")
.header("X-Agent-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"handle\": \"<string>\",\n \"product_type\": \"<string>\",\n \"vendor\": \"<string>\",\n \"price\": 1,\n \"tags\": [\n \"<string>\"\n ],\n \"options\": [\n \"<string>\"\n ],\n \"supplier_id\": \"<string>\",\n \"pdp_template_id\": \"<string>\",\n \"fulfillment_rules\": [\n {\n \"country_codes\": [\n \"<string>\"\n ],\n \"supplier_id\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"category\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.platformdtc.com/api/v1/products/{product_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-Agent-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"handle\": \"<string>\",\n \"product_type\": \"<string>\",\n \"vendor\": \"<string>\",\n \"price\": 1,\n \"tags\": [\n \"<string>\"\n ],\n \"options\": [\n \"<string>\"\n ],\n \"supplier_id\": \"<string>\",\n \"pdp_template_id\": \"<string>\",\n \"fulfillment_rules\": [\n {\n \"country_codes\": [\n \"<string>\"\n ],\n \"supplier_id\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"category\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"merchant_id": "<string>",
"store_id": "<string>",
"title": "<string>",
"handle": "<string>",
"product_type": "<string>",
"vendor": "<string>",
"tags": [
"<string>"
],
"options": [
"<string>"
],
"status": 0,
"status_label": "draft",
"bind_status": 123,
"bind_erp_product_id": "<string>",
"price": 123,
"link": "<string>",
"image_url": "<string>",
"project_id": "<string>",
"supplier_id": "<string>",
"pdp_template_id": "<string>",
"description": "<string>",
"category": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"images": [
{
"id": "<string>",
"url": "<string>",
"width": "<string>",
"height": "<string>"
}
],
"variants": [
{
"id": "<string>",
"product_id": "<string>",
"title": "<string>",
"price": 123,
"sku": "<string>",
"option1": "<string>",
"option2": "<string>",
"option3": "<string>",
"weight": 123,
"weight_unit": "<string>",
"position": 123,
"image_url": "<string>",
"compare_at_price": 123,
"inventory_quantity": 123,
"bind_erp_variant_id": "<string>",
"erp_bundle_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"sales_7_days": "<string>",
"variants_count": 123,
"is_published": true
},
"meta": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}{
"success": false,
"message": "<string>",
"error_code": "NOT_FOUND",
"errors": {}
}Authorizations
Service-account key, format sq_agt_*. Carries least-privilege scopes.
Headers
Optional on the products domain API — absent, the request simply executes. When present, a replay with the same body returns the cached response and a different body returns 409. Send it on every write anyway.
Maximum string length:
200Target store; required when the key is bound to multiple stores.
Path Parameters
Body
application/json
Cents.
Required range:
x >= 0Available options:
0, 1, 2 Default 3PL/supplier. "" unassigns; omit to leave unchanged.
Product-page template. "" falls back to the default; omit to leave unchanged.
Destination-based routing, resolved at order finalize. First matching rule wins.
Show child attributes
Show child attributes
Accepted and ignored — stored in a separate table.
Accepted and ignored — stored in a separate table.