Attributes
Retrieve specific attribute
Path parameters
attributeCodestringRequiredExample:
(Required)
<string>Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
/V1/products/attributes/{attributeCode}Save attribute data
Path parameters
attributeCodestringRequiredExample:
(Required)
<string>Header parameters
Content-TypestringOptionalExample:
application/jsonBody
objectOptionalExample:
{"attribute":{"attribute_code":"incididunt cillum cupidatat magna","frontend_input":"eiusmod consequat fugiat adipisicing","entity_type_id":"ex do","is_required":true,"frontend_labels":[{"store_id":58336445,"label":"voluptate "},{"store_id":-9448356,"label":"ex fugiat"}],"extension_attributes":{},"is_wysiwyg_enabled":true,"is_html_allowed_on_front":false,"used_for_sort_by":true,"is_filterable":false,"is_filterable_in_search":true,"is_used_in_grid":false,"is_visible_in_grid":true,"is_filterable_in_grid":false,"position":-75965978,"apply_to":["Ut","reprehenderit"],"is_searchable":"nostrud reprehenderit sunt ullamco sit","is_visible_in_advanced_search":"Duis elit","is_comparable":"dolore","is_used_for_promo_rules":"nulla","is_visible_on_front":"cupidatat id","used_in_product_listing":"sunt laborum","is_visible":false,"scope":"proident ad Ut deserunt","attribute_id":123152,"options":[{"label":"reprehenderit laborum Lorem amet","value":"enim fugiat veniam","sort_order":30835420,"is_default":true,"store_labels":[{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}},{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}}]},{"label":"ipsum esse","value":"amet ad","sort_order":36026483,"is_default":false,"store_labels":[{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}},{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}}]}],"is_user_defined":true,"default_frontend_label":"eu veniam nulla","note":"dolor elit minim nostrud nisi","backend_type":"dolore pariatur vel","backend_model":"id dolor","source_model":"Ut ad minim velit","default_value":"aute ullamco ea laboris","is_unique":"commodo sed in repreh","frontend_class":"ut","validation_rules":[{"key":"aliqua velit","value":"dolore veniam et aliquip tempor"},{"key":"eiusmod ut ","value":"in aliquip"}],"custom_attributes":[{"attribute_code":"Lorem dolor et v","value":"quis Duis sint"},{"attribute_code":"velit aliquip cupidatat dolor","value":"tempor sunt laborum reprehenderit"}]}}Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
put
/V1/products/attributes/{attributeCode}Delete Attribute by id
Path parameters
attributeCodestringRequiredExample:
(Required)
<string>Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
delete
/V1/products/attributes/{attributeCode}Retrieve all attributes for entity type
Query parameters
searchCriteria[filterGroups][0][filters][0][field]stringOptionalExample:
Field
<string>searchCriteria[filterGroups][0][filters][0][value]stringOptionalExample:
Value
<string>searchCriteria[filterGroups][0][filters][0][conditionType]stringOptionalExample:
Condition type
<string>searchCriteria[sortOrders][0][field]stringOptionalExample:
Sorting field.
<string>searchCriteria[sortOrders][0][direction]stringOptionalExample:
Sorting direction.
<string>searchCriteria[pageSize]stringOptionalExample:
Page size.
<integer>searchCriteria[currentPage]stringOptionalExample:
Current page.
<integer>Responses
200
OK
application/json
Responseobject
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
/V1/products/attributesSave attribute data
Header parameters
Content-TypestringOptionalExample:
application/jsonBody
objectOptionalExample:
{"attribute":{"attribute_code":"incididunt cillum cupidatat magna","frontend_input":"eiusmod consequat fugiat adipisicing","entity_type_id":"ex do","is_required":true,"frontend_labels":[{"store_id":58336445,"label":"voluptate "},{"store_id":-9448356,"label":"ex fugiat"}],"extension_attributes":{},"is_wysiwyg_enabled":true,"is_html_allowed_on_front":false,"used_for_sort_by":true,"is_filterable":false,"is_filterable_in_search":true,"is_used_in_grid":false,"is_visible_in_grid":true,"is_filterable_in_grid":false,"position":-75965978,"apply_to":["Ut","reprehenderit"],"is_searchable":"nostrud reprehenderit sunt ullamco sit","is_visible_in_advanced_search":"Duis elit","is_comparable":"dolore","is_used_for_promo_rules":"nulla","is_visible_on_front":"cupidatat id","used_in_product_listing":"sunt laborum","is_visible":false,"scope":"proident ad Ut deserunt","attribute_id":123152,"options":[{"label":"reprehenderit laborum Lorem amet","value":"enim fugiat veniam","sort_order":30835420,"is_default":true,"store_labels":[{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}},{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}}]},{"label":"ipsum esse","value":"amet ad","sort_order":36026483,"is_default":false,"store_labels":[{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}},{"store_id":{"value":"<Error: Too many levels of nesting to fake this schema>"},"label":{"value":"<Error: Too many levels of nesting to fake this schema>"}}]}],"is_user_defined":true,"default_frontend_label":"eu veniam nulla","note":"dolor elit minim nostrud nisi","backend_type":"dolore pariatur vel","backend_model":"id dolor","source_model":"Ut ad minim velit","default_value":"aute ullamco ea laboris","is_unique":"commodo sed in repreh","frontend_class":"ut","validation_rules":[{"key":"aliqua velit","value":"dolore veniam et aliquip tempor"},{"key":"eiusmod ut ","value":"in aliquip"}],"custom_attributes":[{"attribute_code":"Lorem dolor et v","value":"quis Duis sint"},{"attribute_code":"velit aliquip cupidatat dolor","value":"tempor sunt laborum reprehenderit"}]}}Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
post
/V1/products/attributes