curl --request POST \
--url https://www.closient.com/retailers/api/v1/organizations/{organization_id}/retailers \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"category": "grocery",
"gln": "0078742000015",
"marketplace_regions": [
"US",
"CA"
],
"name": "Green Grocers Co.",
"website": "https://www.greengrocers.com"
}
'import requests
url = "https://www.closient.com/retailers/api/v1/organizations/{organization_id}/retailers"
payload = {
"category": "grocery",
"gln": "0078742000015",
"marketplace_regions": ["US", "CA"],
"name": "Green Grocers Co.",
"website": "https://www.greengrocers.com"
}
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({
category: 'grocery',
gln: '0078742000015',
marketplace_regions: ['US', 'CA'],
name: 'Green Grocers Co.',
website: 'https://www.greengrocers.com'
})
};
fetch('https://www.closient.com/retailers/api/v1/organizations/{organization_id}/retailers', 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/organizations/{organization_id}/retailers",
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([
'category' => 'grocery',
'gln' => '0078742000015',
'marketplace_regions' => [
'US',
'CA'
],
'name' => 'Green Grocers Co.',
'website' => 'https://www.greengrocers.com'
]),
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/organizations/{organization_id}/retailers"
payload := strings.NewReader("{\n \"category\": \"grocery\",\n \"gln\": \"0078742000015\",\n \"marketplace_regions\": [\n \"US\",\n \"CA\"\n ],\n \"name\": \"Green Grocers Co.\",\n \"website\": \"https://www.greengrocers.com\"\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/organizations/{organization_id}/retailers")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"category\": \"grocery\",\n \"gln\": \"0078742000015\",\n \"marketplace_regions\": [\n \"US\",\n \"CA\"\n ],\n \"name\": \"Green Grocers Co.\",\n \"website\": \"https://www.greengrocers.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/retailers/api/v1/organizations/{organization_id}/retailers")
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 \"category\": \"grocery\",\n \"gln\": \"0078742000015\",\n \"marketplace_regions\": [\n \"US\",\n \"CA\"\n ],\n \"name\": \"Green Grocers Co.\",\n \"website\": \"https://www.greengrocers.com\"\n}"
response = http.request(request)
puts response.read_body{
"category": "grocery",
"created": "2025-01-15T10:00:00Z",
"gln": "0078742000008",
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"is_active": true,
"is_canonical": true,
"is_online": true,
"is_physical": true,
"marketplace_regions": [
"US",
"CA",
"GB"
],
"name": "Whole Foods Market",
"website": "https://www.wholefoodsmarket.com"
}{
"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"
}Create retailer
Create an org-private retailer for an organization.
curl --request POST \
--url https://www.closient.com/retailers/api/v1/organizations/{organization_id}/retailers \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"category": "grocery",
"gln": "0078742000015",
"marketplace_regions": [
"US",
"CA"
],
"name": "Green Grocers Co.",
"website": "https://www.greengrocers.com"
}
'import requests
url = "https://www.closient.com/retailers/api/v1/organizations/{organization_id}/retailers"
payload = {
"category": "grocery",
"gln": "0078742000015",
"marketplace_regions": ["US", "CA"],
"name": "Green Grocers Co.",
"website": "https://www.greengrocers.com"
}
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({
category: 'grocery',
gln: '0078742000015',
marketplace_regions: ['US', 'CA'],
name: 'Green Grocers Co.',
website: 'https://www.greengrocers.com'
})
};
fetch('https://www.closient.com/retailers/api/v1/organizations/{organization_id}/retailers', 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/organizations/{organization_id}/retailers",
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([
'category' => 'grocery',
'gln' => '0078742000015',
'marketplace_regions' => [
'US',
'CA'
],
'name' => 'Green Grocers Co.',
'website' => 'https://www.greengrocers.com'
]),
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/organizations/{organization_id}/retailers"
payload := strings.NewReader("{\n \"category\": \"grocery\",\n \"gln\": \"0078742000015\",\n \"marketplace_regions\": [\n \"US\",\n \"CA\"\n ],\n \"name\": \"Green Grocers Co.\",\n \"website\": \"https://www.greengrocers.com\"\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/organizations/{organization_id}/retailers")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"category\": \"grocery\",\n \"gln\": \"0078742000015\",\n \"marketplace_regions\": [\n \"US\",\n \"CA\"\n ],\n \"name\": \"Green Grocers Co.\",\n \"website\": \"https://www.greengrocers.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/retailers/api/v1/organizations/{organization_id}/retailers")
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 \"category\": \"grocery\",\n \"gln\": \"0078742000015\",\n \"marketplace_regions\": [\n \"US\",\n \"CA\"\n ],\n \"name\": \"Green Grocers Co.\",\n \"website\": \"https://www.greengrocers.com\"\n}"
response = http.request(request)
puts response.read_body{
"category": "grocery",
"created": "2025-01-15T10:00:00Z",
"gln": "0078742000008",
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"is_active": true,
"is_canonical": true,
"is_online": true,
"is_physical": true,
"marketplace_regions": [
"US",
"CA",
"GB"
],
"name": "Whole Foods Market",
"website": "https://www.wholefoodsmarket.com"
}{
"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
Path Parameters
UUID of the organization to create the retailer for.
22^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Body
Developer-attached key/value data. Send {} or null to clear. Empty-string values delete that key. Omitted keys are preserved.
Show child attributes
Show child attributes
Retailer's homepage. Must start with http:// or https://; any other scheme (javascript:, data:, ftp:, ...) is refused with a 422. Empty for none.
200^([Hh][Tt][Tt][Pp][Ss]?://[^\x00-\x20\x7f/?#][^\x00-\x20\x7f]{0,191})?$Response
OK
URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
22^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$Retailer display name.
When the retailer was created.
Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.
Show child attributes
Show child attributes
Derived — true iff the retailer has at least one active OnlineStore.
Derived — true iff the retailer has at least one active PhysicalStore.
Retailer's canonical homepage URL (separate from individual storefronts).
GS1 Global Location Number.
True for Closient-curated retailers (read-only).
URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).
22^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$ISO 3166-1 alpha-2 region codes.
Retailer type/category classification.
Whether the retailer is active.