curl --request POST \
--url https://www.closient.com/products/api/v1/consumables \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"consumable_gtin": "00850012345671",
"estimated_lifespan": "6 months",
"gtin": "00850012345688",
"is_required": true,
"note": "Replace when the indicator light turns red."
}
'import requests
url = "https://www.closient.com/products/api/v1/consumables"
payload = {
"consumable_gtin": "00850012345671",
"estimated_lifespan": "6 months",
"gtin": "00850012345688",
"is_required": True,
"note": "Replace when the indicator light turns red."
}
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({
consumable_gtin: '00850012345671',
estimated_lifespan: '6 months',
gtin: '00850012345688',
is_required: true,
note: 'Replace when the indicator light turns red.'
})
};
fetch('https://www.closient.com/products/api/v1/consumables', 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/products/api/v1/consumables",
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([
'consumable_gtin' => '00850012345671',
'estimated_lifespan' => '6 months',
'gtin' => '00850012345688',
'is_required' => true,
'note' => 'Replace when the indicator light turns red.'
]),
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/products/api/v1/consumables"
payload := strings.NewReader("{\n \"consumable_gtin\": \"00850012345671\",\n \"estimated_lifespan\": \"6 months\",\n \"gtin\": \"00850012345688\",\n \"is_required\": true,\n \"note\": \"Replace when the indicator light turns red.\"\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/products/api/v1/consumables")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"consumable_gtin\": \"00850012345671\",\n \"estimated_lifespan\": \"6 months\",\n \"gtin\": \"00850012345688\",\n \"is_required\": true,\n \"note\": \"Replace when the indicator light turns red.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/products/api/v1/consumables")
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 \"consumable_gtin\": \"00850012345671\",\n \"estimated_lifespan\": \"6 months\",\n \"gtin\": \"00850012345688\",\n \"is_required\": true,\n \"note\": \"Replace when the indicator light turns red.\"\n}"
response = http.request(request)
puts response.read_body{
"consumable": {
"gtin": "00850012345671",
"id": "8Jw2nQxK5vTbR3mYcLdZaE",
"product_name": "Carrying Case"
},
"created": "2026-09-30T09:00:00Z",
"estimated_lifespan": "6 months",
"id": "F5n5NdW6dTbvPYkgnLNjte",
"is_required": true,
"modified": "2026-09-30T09:00:00Z",
"note": "Replace when the indicator light turns red.",
"organization_id": "9fHkqR2aXcVbNmLpQwErTy",
"product": {
"gtin": "00850012345688",
"id": "SBjSX6xUJPPHQKUXBpYX2C",
"product_name": "Countertop Water Purifier"
}
}{
"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"
}{
"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 consumable
List one of the organization’s products as a consumable of another. Requires CONTRIBUTE on the organization. 404 if either GTIN isn’t a product the organization owns; 409 if the pair already exists; 422 if a product is made its own consumable. Nothing is created on error.
curl --request POST \
--url https://www.closient.com/products/api/v1/consumables \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"consumable_gtin": "00850012345671",
"estimated_lifespan": "6 months",
"gtin": "00850012345688",
"is_required": true,
"note": "Replace when the indicator light turns red."
}
'import requests
url = "https://www.closient.com/products/api/v1/consumables"
payload = {
"consumable_gtin": "00850012345671",
"estimated_lifespan": "6 months",
"gtin": "00850012345688",
"is_required": True,
"note": "Replace when the indicator light turns red."
}
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({
consumable_gtin: '00850012345671',
estimated_lifespan: '6 months',
gtin: '00850012345688',
is_required: true,
note: 'Replace when the indicator light turns red.'
})
};
fetch('https://www.closient.com/products/api/v1/consumables', 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/products/api/v1/consumables",
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([
'consumable_gtin' => '00850012345671',
'estimated_lifespan' => '6 months',
'gtin' => '00850012345688',
'is_required' => true,
'note' => 'Replace when the indicator light turns red.'
]),
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/products/api/v1/consumables"
payload := strings.NewReader("{\n \"consumable_gtin\": \"00850012345671\",\n \"estimated_lifespan\": \"6 months\",\n \"gtin\": \"00850012345688\",\n \"is_required\": true,\n \"note\": \"Replace when the indicator light turns red.\"\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/products/api/v1/consumables")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"consumable_gtin\": \"00850012345671\",\n \"estimated_lifespan\": \"6 months\",\n \"gtin\": \"00850012345688\",\n \"is_required\": true,\n \"note\": \"Replace when the indicator light turns red.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.closient.com/products/api/v1/consumables")
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 \"consumable_gtin\": \"00850012345671\",\n \"estimated_lifespan\": \"6 months\",\n \"gtin\": \"00850012345688\",\n \"is_required\": true,\n \"note\": \"Replace when the indicator light turns red.\"\n}"
response = http.request(request)
puts response.read_body{
"consumable": {
"gtin": "00850012345671",
"id": "8Jw2nQxK5vTbR3mYcLdZaE",
"product_name": "Carrying Case"
},
"created": "2026-09-30T09:00:00Z",
"estimated_lifespan": "6 months",
"id": "F5n5NdW6dTbvPYkgnLNjte",
"is_required": true,
"modified": "2026-09-30T09:00:00Z",
"note": "Replace when the indicator light turns red.",
"organization_id": "9fHkqR2aXcVbNmLpQwErTy",
"product": {
"gtin": "00850012345688",
"id": "SBjSX6xUJPPHQKUXBpYX2C",
"product_name": "Countertop Water Purifier"
}
}{
"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"
}{
"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
Body
Payload for POST /consumables.
GTIN (8, 12, 13 or 14 digits) of the product the consumable belongs to. Must be a product the caller's organization owns, else 404.
8 - 14GTIN of the product that is the consumable. Must be a product the same organization owns, else 404 and nothing is created.
8 - 14How long one unit lasts, as free text (for example 6 months).
100^[^\x00]{0,100}$Whether the product needs this consumable to work.
Short note shown with the consumable.
255^[^\x00]{0,255}$Response
Created
A consumable of one of the organization's products.
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}$The organization that owns the product.
22^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$The product the consumable is used with.
Show child attributes
Show child attributes
{
"gtin": "00850012345671",
"id": "8Jw2nQxK5vTbR3mYcLdZaE",
"product_name": "Carrying Case"
}
The product that serves as the consumable.
Show child attributes
Show child attributes
{
"gtin": "00850012345671",
"id": "8Jw2nQxK5vTbR3mYcLdZaE",
"product_name": "Carrying Case"
}
How long one unit lasts, as free text. Empty when unset.
Whether the product needs this consumable to work.
Short note shown with the consumable. Empty when unset.
Server-side ISO 8601 timestamp of creation (UTC).
Server-side ISO 8601 timestamp of last modification (UTC).