Skip to content

PM11 - Get the product attribute configuration

Request

Description

Retrieves all attributes for parents and children of the requested hierarchy

Call Frequency
Maximum usage: Every hour
Read More
Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMIN
ROLE_PARTNER_PRODUCT_CONFIGURATI...
)
Query
hierarchystring

Code of the hierarchy (category) for which to retrieve the attributes. If not specified, all attributes are retrieved.

max_levelinteger, (int32)

Number of children hierarchy (category) levels to retrieve. If not specified, attributes from all children hierarchies are retrieved.

all_operator_attributesboolean

Set to "true" to get all the operator attributes.

Default:false
with_rolesboolean

Set to "true" to get only the attributes that have roles.

Default:false
shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/products/attributes?hierarchy=string&max_level=0&all_operator_attributes=false&with_roles=false&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Export success

Body
attributesArray of objectsrequired

List of attributes

Response
{ "attributes": [ { … }, { … } ] }