Akeneo PIM REST API
  1. Category
Akeneo PIM REST API
  • Authentication
    • Get authentication token
      POST
  • Overview
    • Get list of all endpoints
      GET
  • PAM asset category
    • Get list of PAM asset categories
      GET
    • Update/create several PAM asset categories
      PATCH
    • Create a new PAM asset category
      POST
    • Get a PAM asset category
      GET
    • Update/create a PAM asset category
      PATCH
  • Asset family
    • Get list of asset families
      GET
    • Get an asset family
      GET
    • Update/create an asset family
      PATCH
  • Asset
    • Get the list of the assets of a given asset family
      GET
    • Update/create several assets
      PATCH
    • Delete an asset
      DELETE
    • Get an asset of a given asset family
      GET
    • Update/create an asset
      PATCH
  • Asset attribute
    • Get the list of attributes of a given asset family
      GET
    • Get an attribute of a given asset family
      GET
    • Update/create an attribute of a given asset family
      PATCH
  • Asset attribute option
    • Get a list of attribute options of a given attribute for a given asset family
    • Get an attribute option for a given attribute of a given asset family
    • Update/create an asset attribute option for a given asset family
  • Asset media file
    • Create a new media file for an asset
    • Download the media file associated to an asset
  • PAM asset tag
    • Get list of PAM asset tags
    • Get a PAM asset tag
    • Update/create a PAM asset tag
  • PAM asset
    • Get list of PAM assets
    • Update/create several PAM assets
    • Create a new PAM asset
    • Get a PAM asset
    • Update/create a PAM asset
  • PAM asset reference file
    • Get a reference file
    • Upload a new reference file
    • Download a reference file
  • PAM asset variation file
    • Get a variation file
    • Upload a new variation file
    • Download a variation file
  • Association type
    • Get a list of association types
    • Update/create several association types
    • Create a new association type
    • Get an association type
    • Update/create an association type
  • Attribute group
    • Get list of attribute groups
    • Update/create several attribute groups
    • Create a new attribute group
    • Get an attribute group
    • Update/create an attribute group
  • Attribute
    • Get list of attributes
    • Update/create several attributes
    • Create a new attribute
    • Get an attribute
    • Update/create an attribute
  • Attribute option
    • Get list of attribute options
    • Update/create several attribute options
    • Create a new attribute option
    • Get an attribute option
    • Update/create an attribute option
  • Category
    • Get list of categories
      GET
    • Update/create several categories
      PATCH
    • Create a new category
      POST
    • Get a category
      GET
    • Update/create a category
      PATCH
    • Download a category media file [COMING SOON]
      GET
  • Channel
    • Get a list of channels
    • Update/create several channels
    • Create a new channel
    • Get a channel
    • Update/create a channel
  • Currency
    • Get a list of currencies
    • Get a currency
  • Family
    • Get list of families
    • Update/create several families
    • Create a new family
    • Get a family
    • Update/create a family
    • Create a new family variant
  • Family variant
    • Get list of family variants
    • Update/create several family variants
    • Get a family variant
    • Update/create a family variant
  • Locale
    • Get a list of locales
    • Get a locale
  • Measure family
    • Get list of measure familiy
    • Get a measure family
  • Measurement family
    • Get list of measurement families
    • Update/create several measurement families
  • Product media file
    • Get a list of product media files
    • Create a new product media file
    • Get a product media file
    • Download a product media file
  • Product model
    • Get list of product models
    • Update/create several product models
    • Create a new product model
    • Delete a product model
    • Get a product model
    • Update/create a product model
    • Get a draft
    • Submit a draft for approval
  • Product
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  • Published product
    • Get list of published products
    • Get a published product
  • Reference entity
    • Get list of reference entities
    • Get a reference entity
    • Update/create a reference entity
  • Reference entity media file
    • Create a new media file for a reference entity or a record
    • Download the media file associated to a reference entity or a record
  • Reference entity attribute
    • Get the list of attributes of a given reference entity
    • Get an attribute of a given reference entity
    • Update/create an attribute of a given reference entity
  • Reference entity attribute option
    • Get a list of attribute options of a given attribute for a given reference entity
    • Get an attribute option for a given attribute of a given reference entity
    • Update/create a reference entity attribute option
  • Reference entity record
    • Get the list of the records of a reference entity
    • Update/create several reference entity records
    • Get a record of a given reference entity
    • Update/create a record of a given reference entity
  • System
    • Get system information
    • Get system information
  • Catalogs
    • Get the list of owned catalogs
    • Create a new catalog
    • Delete a catalog
    • Get a catalog
    • Update a catalog
  • Catalog products
    • Get the list of product uuids
    • Get the list of products related to a catalog
    • Get a product related to a catalog
  • Product [identifier]
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  • Product [uuid]
    • Get list of products
    • Update/create several products
    • Create a new product
    • Delete a product
    • Get a product
    • Update/create a product
    • Get a draft
    • Submit a draft for approval
  1. Category

Get a category

GET
/api/rest/v1/categories/{code}
Category
This endpoint allows you to get the information about a given category.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/api/rest/v1/categories/'
Response Response Example
200 - Example 1
{
  "code": "winter_collection",
  "labels": {
    "en_US": "Winter collection",
    "fr_FR": "Collection hiver"
  },
  "parent": null,
  "position": 1,
  "updated": "2023-08-15T05:53:50.708Z",
  "values": {
    "description|96b88bf4-c2b7-4b64-a1f9-5d4876c02c26|ecommerce|en_US": {
      "attribute_code": "description|96b88bf4-c2b7-4b64-a1f9-5d4876c02c26",
      "channel": "ecommerce",
      "data": "<p>Winter collection description</p>\n",
      "locale": "en_US",
      "type": "textarea"
    }
  }
}

Request

Path Params
code
string 
required
Code of the resource
Query Params
with_position
string 
optional
Return information about category position into its category tree (only available since the 7.0 version)
with_enriched_attributes
string 
optional

Return attribute values of the category (only available on SaaS platforms) [COMING SOON]

Responses

🟢200OK
application/json
Body
code
string 
required
Category code
labels
object 
optional
Category labels for each locale
Default:
{}
localeCode
string 
optional
Category label for the locale localeCode
parent
string 
optional
Category code of the parent's category
Default:
null
position
integer 
optional
Position of the category in its level, start from 1 (only available since the 7.0 version and when query parameter "with_position" is set to "true")
updated
string <dateTime>
optional
Date of the last update
values
object 
optional
Attribute values
Default:
null
attributeCode|attributeUuid|channelCode|localeCode
array [object {5}] 
optional
🟠401Authentication required
🟠403Access forbidden
🟠404Resource not found
🟠406Not Acceptable
Modified at 2023-08-15 05:53:55
Previous
Create a new category
Next
Update/create a category
Built with