Check completeness for a channel
curl --request GET \
--url https://www.merchkit.com/api/v1/products/{id}/completeness \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.merchkit.com/api/v1/products/{id}/completeness"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.merchkit.com/api/v1/products/{id}/completeness', 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.merchkit.com/api/v1/products/{id}/completeness",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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 := "https://www.merchkit.com/api/v1/products/{id}/completeness"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.merchkit.com/api/v1/products/{id}/completeness")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.merchkit.com/api/v1/products/{id}/completeness")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"product_id": "9b2f6c1e-8a04-4c6e-b0d3-5f2f6f7a9e21",
"channel": "wayfair",
"is_complete": false,
"missing_count": 1,
"invalid_count": 1,
"issues": [
{
"key": "description",
"name": "Description",
"status": "missing",
"current_value": null,
"requirement": "required"
},
{
"key": "assembly_required",
"name": "Assembly Required",
"status": "invalid",
"current_value": "maybe",
"requirement": "required",
"acceptable_values": [
"Yes",
"No"
]
}
]
}
}{
"error": {
"code": "validation_failed",
"message": "Unknown attribute key(s): colour.",
"documentation_url": "https://docs.merchkit.com/developers/errors#validation_failed",
"is_retriable": false,
"retry_after_seconds": null,
"alternative_action": "List valid attribute keys via GET /v1/attributes?type=product.",
"request_id": "req_01j9x2k8",
"field_errors": [
{
"field": "colour",
"issue": "not_a_defined_attribute"
}
]
}
}Channel readiness
Check completeness for a channel
Recomputes the product’s completeness for one channel on demand. channel is REQUIRED — completeness is per-channel. Issues carry acceptable_values where applicable: exactly what the write path validates against, so the fix loop closes without a human.
Scope: read:products.
GET
/
products
/
{id}
/
completeness
Check completeness for a channel
curl --request GET \
--url https://www.merchkit.com/api/v1/products/{id}/completeness \
--header 'Authorization: Bearer <token>'import requests
url = "https://www.merchkit.com/api/v1/products/{id}/completeness"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.merchkit.com/api/v1/products/{id}/completeness', 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.merchkit.com/api/v1/products/{id}/completeness",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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 := "https://www.merchkit.com/api/v1/products/{id}/completeness"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.merchkit.com/api/v1/products/{id}/completeness")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.merchkit.com/api/v1/products/{id}/completeness")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"product_id": "9b2f6c1e-8a04-4c6e-b0d3-5f2f6f7a9e21",
"channel": "wayfair",
"is_complete": false,
"missing_count": 1,
"invalid_count": 1,
"issues": [
{
"key": "description",
"name": "Description",
"status": "missing",
"current_value": null,
"requirement": "required"
},
{
"key": "assembly_required",
"name": "Assembly Required",
"status": "invalid",
"current_value": "maybe",
"requirement": "required",
"acceptable_values": [
"Yes",
"No"
]
}
]
}
}{
"error": {
"code": "validation_failed",
"message": "Unknown attribute key(s): colour.",
"documentation_url": "https://docs.merchkit.com/developers/errors#validation_failed",
"is_retriable": false,
"retry_after_seconds": null,
"alternative_action": "List valid attribute keys via GET /v1/attributes?type=product.",
"request_id": "req_01j9x2k8",
"field_errors": [
{
"field": "colour",
"issue": "not_a_defined_attribute"
}
]
}
}Authorizations
Workspace-scoped API key (mk_live_...). Each operation lists the scope it requires in x-required-scopes. See the Authentication guide for the full scope table and key management.
Path Parameters
The resource UUID.
Query Parameters
A channel id from GET /channels.
Response
Completeness status.
A product's readiness for one channel.
Show child attributes
Show child attributes
Was this page helpful?