Skip to content

Score a product's completeness

GET
/stores/{storeRef}/products/{id}/completeness
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/products/1/completeness \
--header 'x-api-key: <x-api-key>'

Scores how completely the product’s attributes cover the ones its category expects. The score is guidance only and never blocks a write.

Required scopes: read:products

id
required
integer

The product ID.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
score
required

Score from 0 to 100; 100 when the category declares no attributes.

number
missing_required
required

Codes of required attributes the product does not have.

Array<string>
unbound_axes
required

Codes of variant axes the category does not declare.

Array<string>

Example generated

{
"score": 1,
"missing_required": [
"example"
],
"unbound_axes": [
"example"
]
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}