v1

latestSwagger 2.02026-07-13137761.0 MB
Attribute option

Get list of attribute options

This endpoint allows you to get a list of attribute options. Attribute options are paginated and sorted by code.

get/api/rest/v1/attributes/{attribute_code}/options

Path parameters

attribute_codestring required

Code of the attribute

Query parameters

pageinteger

Number of the page to retrieve when using the page pagination method type. <strong>Should never be set manually</strong>, see <a href="/documentation/pagination.html#pagination">Pagination</a> section

limitinteger

Number of results by page, see <a href="/documentation/pagination.html">Pagination</a> section

with_countboolean

Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way

Response

Return attribute options paginated

current_pageinteger

Current page number

Example response

{
  "_embedded": {
    "items": [
      {
        "code": "black",
        "attribute": "a_simple_select",
        "sort_order": 2,
        "labels": {
          "en_US": "Black",
          "fr_FR": "Noir"
        }
      }
    ]
  }
}