Upsert retailer product listings in bulk
curl --request POST \
--url https://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/batch \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"dry_run": false,
"rows": [
{
"attributes": {
"Category1": "Skin Care"
},
"badges": [
{
"label": "Clean at Sephora"
}
],
"gtin": "00614141000036",
"sku": "2512345",
"urls": [
{
"store_url": "https://www.sephora.com",
"url": "https://www.sephora.com/product/example-P123456"
}
]
}
],
"source": "sephora_catalog"
}
'import requests
url = "https://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/batch"
payload = {
"dry_run": False,
"rows": [
{
"attributes": { "Category1": "Skin Care" },
"badges": [{ "label": "Clean at Sephora" }],
"gtin": "00614141000036",
"sku": "2512345",
"urls": [
{
"store_url": "https://www.sephora.com",
"url": "https://www.sephora.com/product/example-P123456"
}
]
}
],
"source": "sephora_catalog"
}
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({
dry_run: false,
rows: [
{
attributes: {Category1: 'Skin Care'},
badges: [{label: 'Clean at Sephora'}],
gtin: '00614141000036',
sku: '2512345',
urls: [
{
store_url: 'https://www.sephora.com',
url: 'https://www.sephora.com/product/example-P123456'
}
]
}
],
source: 'sephora_catalog'
})
};
fetch('https://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/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_URL => "https://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/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([
'dry_run' => false,
'rows' => [
[
'attributes' => [
'Category1' => 'Skin Care'
],
'badges' => [
[
'label' => 'Clean at Sephora'
]
],
'gtin' => '00614141000036',
'sku' => '2512345',
'urls' => [
[
'store_url' => 'https://www.sephora.com',
'url' => 'https://www.sephora.com/product/example-P123456'
]
]
]
],
'source' => 'sephora_catalog'
]),
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://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/batch"
payload := strings.NewReader("{\n \"dry_run\": false,\n \"rows\": [\n {\n \"attributes\": {\n \"Category1\": \"Skin Care\"\n },\n \"badges\": [\n {\n \"label\": \"Clean at Sephora\"\n }\n ],\n \"gtin\": \"00614141000036\",\n \"sku\": \"2512345\",\n \"urls\": [\n {\n \"store_url\": \"https://www.sephora.com\",\n \"url\": \"https://www.sephora.com/product/example-P123456\"\n }\n ]\n }\n ],\n \"source\": \"sephora_catalog\"\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://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/batch")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dry_run\": false,\n \"rows\": [\n {\n \"attributes\": {\n \"Category1\": \"Skin Care\"\n },\n \"badges\": [\n {\n \"label\": \"Clean at Sephora\"\n }\n ],\n \"gtin\": \"00614141000036\",\n \"sku\": \"2512345\",\n \"urls\": [\n {\n \"store_url\": \"https://www.sephora.com\",\n \"url\": \"https://www.sephora.com/product/example-P123456\"\n }\n ]\n }\n ],\n \"source\": \"sephora_catalog\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/batch")
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 \"dry_run\": false,\n \"rows\": [\n {\n \"attributes\": {\n \"Category1\": \"Skin Care\"\n },\n \"badges\": [\n {\n \"label\": \"Clean at Sephora\"\n }\n ],\n \"gtin\": \"00614141000036\",\n \"sku\": \"2512345\",\n \"urls\": [\n {\n \"store_url\": \"https://www.sephora.com\",\n \"url\": \"https://www.sephora.com/product/example-P123456\"\n }\n ]\n }\n ],\n \"source\": \"sephora_catalog\"\n}"
response = http.request(request)
puts response.read_body{
"committed": true,
"created": 1,
"errors": 0,
"invalid": 0,
"rows": [
{
"badges": 2,
"error": "",
"gtin": "00614141000036",
"index": 0,
"listing_id": "b2c3d4e5-f678-9012-abcd-ef2345678901",
"outcome": "created",
"urls": 1
}
],
"submitted_rows": 2,
"unknown_gtin": 0,
"updated": 1
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}Retailer Listings
Upsert retailer product listings in bulk
Create or update up to 500 retailer product listings, keyed on (retailer, GTIN), returning a per-row result.
Idempotent: rerunning an unchanged feed writes nothing new. Badges and per-property URLs are synced to each payload, so a badge the retailer dropped stops rendering on the next run — with one deliberate asymmetry: an empty urls list means ‘this feed has no URL information’ and deactivates nothing, while a non-empty list deactivates the properties it omits.
A row whose GTIN has no product is reported as unknown_gtin and writes nothing; listings never create products, so per-field provenance is only ever written by the import engine. A row naming a storefront this retailer has no active property for is reported as invalid — declare the property with POST /retailers/{retailer_id}/storefronts first.
retailer_id is a retailers.Retailer. An organization-private retailer requires OWNER or MANAGER on the organization that owns it; a canonical (Closient-curated) retailer requires a staff account.
Returns 200 with a per-row error report even on partial success. Attribute-bound breaches are 422 naming the offending row, because the caller must change what it sends.
POST
/
retailers
/
api
/
v1
/
retailers
/
{retailer_id}
/
listings
/
batch
Upsert retailer product listings in bulk
curl --request POST \
--url https://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/batch \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"dry_run": false,
"rows": [
{
"attributes": {
"Category1": "Skin Care"
},
"badges": [
{
"label": "Clean at Sephora"
}
],
"gtin": "00614141000036",
"sku": "2512345",
"urls": [
{
"store_url": "https://www.sephora.com",
"url": "https://www.sephora.com/product/example-P123456"
}
]
}
],
"source": "sephora_catalog"
}
'import requests
url = "https://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/batch"
payload = {
"dry_run": False,
"rows": [
{
"attributes": { "Category1": "Skin Care" },
"badges": [{ "label": "Clean at Sephora" }],
"gtin": "00614141000036",
"sku": "2512345",
"urls": [
{
"store_url": "https://www.sephora.com",
"url": "https://www.sephora.com/product/example-P123456"
}
]
}
],
"source": "sephora_catalog"
}
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({
dry_run: false,
rows: [
{
attributes: {Category1: 'Skin Care'},
badges: [{label: 'Clean at Sephora'}],
gtin: '00614141000036',
sku: '2512345',
urls: [
{
store_url: 'https://www.sephora.com',
url: 'https://www.sephora.com/product/example-P123456'
}
]
}
],
source: 'sephora_catalog'
})
};
fetch('https://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/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_URL => "https://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/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([
'dry_run' => false,
'rows' => [
[
'attributes' => [
'Category1' => 'Skin Care'
],
'badges' => [
[
'label' => 'Clean at Sephora'
]
],
'gtin' => '00614141000036',
'sku' => '2512345',
'urls' => [
[
'store_url' => 'https://www.sephora.com',
'url' => 'https://www.sephora.com/product/example-P123456'
]
]
]
],
'source' => 'sephora_catalog'
]),
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://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/batch"
payload := strings.NewReader("{\n \"dry_run\": false,\n \"rows\": [\n {\n \"attributes\": {\n \"Category1\": \"Skin Care\"\n },\n \"badges\": [\n {\n \"label\": \"Clean at Sephora\"\n }\n ],\n \"gtin\": \"00614141000036\",\n \"sku\": \"2512345\",\n \"urls\": [\n {\n \"store_url\": \"https://www.sephora.com\",\n \"url\": \"https://www.sephora.com/product/example-P123456\"\n }\n ]\n }\n ],\n \"source\": \"sephora_catalog\"\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://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/batch")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dry_run\": false,\n \"rows\": [\n {\n \"attributes\": {\n \"Category1\": \"Skin Care\"\n },\n \"badges\": [\n {\n \"label\": \"Clean at Sephora\"\n }\n ],\n \"gtin\": \"00614141000036\",\n \"sku\": \"2512345\",\n \"urls\": [\n {\n \"store_url\": \"https://www.sephora.com\",\n \"url\": \"https://www.sephora.com/product/example-P123456\"\n }\n ]\n }\n ],\n \"source\": \"sephora_catalog\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/retailers/api/v1/retailers/{retailer_id}/listings/batch")
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 \"dry_run\": false,\n \"rows\": [\n {\n \"attributes\": {\n \"Category1\": \"Skin Care\"\n },\n \"badges\": [\n {\n \"label\": \"Clean at Sephora\"\n }\n ],\n \"gtin\": \"00614141000036\",\n \"sku\": \"2512345\",\n \"urls\": [\n {\n \"store_url\": \"https://www.sephora.com\",\n \"url\": \"https://www.sephora.com/product/example-P123456\"\n }\n ]\n }\n ],\n \"source\": \"sephora_catalog\"\n}"
response = http.request(request)
puts response.read_body{
"committed": true,
"created": 1,
"errors": 0,
"invalid": 0,
"rows": [
{
"badges": 2,
"error": "",
"gtin": "00614141000036",
"index": 0,
"listing_id": "b2c3d4e5-f678-9012-abcd-ef2345678901",
"outcome": "created",
"urls": 1
}
],
"submitted_rows": 2,
"unknown_gtin": 0,
"updated": 1
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}{
"detail": "The requested resource was not found.",
"error_code": "not_found",
"retryable": false,
"status": 404,
"timestamp": "2026-03-31T12:00:00+00:00",
"title": "Not Found",
"type": "https://closient.com/docs/errors/not_found"
}Authorizations
APIKeyHeaderAuthOAuthTokenAuthCookieGatedSessionAuth
Path Parameters
Unique identifier of the retailer these listings belong to.
Required string length:
22Pattern:
^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Body
application/json
A batch of listing rows.
Listing rows, at most 500 per call. Results come back in request order, each carrying its index. For a whole retailer catalog use the retailer-catalog import job instead — it merges products and listings together under one cross-retailer precedence policy.
Required array length:
1 - 500 elementsShow child attributes
Show child attributes
Dataset name recorded on each listing's source column, for provenance.
Maximum string length:
100Execute everything and roll back. Defaults to false, unlike the store upsert: a listing write is a targeted change the caller named by GTIN, not a reconciliation whose matching decisions want previewing first.
Response
OK
Batch census plus the per-row results.
created + updated + unknown_gtin + invalid + errors equals the number
of submitted rows for any 200 response. Per-row failures are reported
here rather than aborting the batch; only request-level failures are 4xx.
False when this was a dry run and the transaction was rolled back.
Number of rows in the request.
Required range:
x >= 0Rows that produced a new listing.
Required range:
x >= 0Rows that refreshed an existing listing.
Required range:
x >= 0Rows whose GTIN has no product. Nothing was written for them.
Required range:
x >= 0Rows rejected by barcode or storefront validation.
Required range:
x >= 0Rows that raised.
Required range:
x >= 0One result per submitted row, in request order.
Show child attributes
Show child attributes