Retrieve an attribute definition

get /api/attribute_definitions/{id}

Retrieves a AttributeDefinition resource.

Returns a single attribute definition by id, including its translatable name, the categories it is attached to and its valuesCount. This endpoint is only available in the unstable version.

Headers

Name	Type	Required	Description
Flowkiwi-Locale	string	-	Specifies the locale for properties that support localization. If not provided, the default locale will be used.

Path parameters

Name	Type	Required	Description
id	string	required	AttributeDefinition identifier

Query parameters

Name	Type	Required	Description
properties[]	string[]	-	Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

Response

200 - AttributeDefinition resource

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
categories	string[]	-	The categories this attribute definition is attached to. Requires the categories:read scope. Returned empty when the scope is missing.
code	string | null	-	The stable, machine-readable identifier of the attribute definition (e.g. color, care-instructions). Immutable once created.
createdAt	string	-	Creation date of the resource (ISO 8601 format).
id	string	-
multiple	boolean	-	Whether products may carry several values for this definition (one per option). Meaningful for list definitions only; always false for string definitions regardless of the requested value. Immutable once created.
name	string | null	-	This property supports translations. The human-readable name of the attribute definition.
type	"string" | "list" | null	-	The type of the attribute definition, determining whether its values are free text (string) or must come from a fixed set of options (list). Immutable once created.
updatedAt	string	-	Last modification date of the resource (ISO 8601 format).
valuesCount	integer	-	The count of the product attribute values that reference this definition.

Errors

403 - Access denied. The caller is missing one or more permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
detail	string	-
missingPermissions	string[]	-	Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
status	integer	-
title	string	-
type	string	-

404 - Not found

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
code	string	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
description	string | null	-
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message	string	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug	string	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status	integer | null	-
title	string | null	-	A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type	string	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.