Using the Category Tree API

This API required Authentication

Create a category tree

POST /category-trees

Query Parameters

Name	Type	Description
environment*	string
tenant*	string
fhrValidation	String	True/false. Enforces specific validation to comply with the Fredhopper data model

Headers

Name	Type	Description
Authorization*	string	Bearer token

Request Body

Name	Type	Description
categoryTree*	object	Category Tree

200

{
    "version": 1
}

400: Bad Request categoryTree validation failed (see api errors belows)

{
    // Response
}

409: Conflict categoryTree already exists

{
    // Response
}

The root name can't be "0"

Category tree request example

> POST /category-trees

{
    "name": "catalog01",
    "localizedNames": [
        {
            "locale": "en_GB",
            "value": "Home"
        },
        {
            "locale": "de_DE",
            "value": "Startseite"
        }
    ],
    "tenant": "demo",
    "environment": "fas:live1",
    "children": [
        {
            "name": "dresses21",
            "localizedNames": [
                {
                    "locale": "en_GB",
                    "name": "Dresses"
                },
                {
                    "locale": "de_DE",
                    "name": "Kleider"
                }
            ]
        }
    ]
}

Update a category tree

PUT https://items.attraqt.io/category-trees/{name}

Path Parameters

Name	Type	Description
name*	string	Category tree root name

Query Parameters

Name	Type	Description
tenant*	String
environment*	String
fhrValidation	String	True/false. Enforces specific validation to comply with the Fredhopper data model

Headers

Name	Type	Description
Authorization*	string	Bearer token containing the following permission:

Request Body

Name	Type	Description
categoryTree*	object

200

{
    "version": 2    
}

400: Bad Request validation failed

{
    // Response
}

404: Not Found

{
    // Response
}

List category trees

GET https://items.attraqt.io/category-trees

Query Parameters

Name	Type	Description
nameSearchPattern	string
tenant*	string
environment*	string

Headers

Name	Type	Description
Authorization*	string	Bearer token

200

{
    "categoryTrees": [
      {
        "tenant": "foo",
        "environment": "main",
        "version": 1,
        "name": "root",
        "children": [
          {
            "name": "child-1",
            "localizedNames": [
              {
                "name": "feuille",
                "locale": "fr"
              }
            ],
            "children": []
          }
        ],
        "localizedNames": [
          {
            "name": "racine",
            "locale": "fr"
          }
        ]
      }
    ]
  }

Get a category tree

GET https://items.attraqt.io/category-trees/{name}/{version}

Path Parameters

Name	Type	Description
version*	number	Version of the category tree
name*	string	Category tree root name

Query Parameters

Name	Type	Description
tenant*	String
environment*	String

Headers

Name	Type	Description
Authorization*	string	Bearer token containing the following permission:

200

 {
  "tenant": "foo",
  "environment": "main",
  "version": 1,
  "name": "root",
  "children": [
    {
      "name": "child-1",
      "localizedNames": [
        {
          "name": "feuille",
          "locale": "fr"
        }
      ],
      "children": []
    }
  ],
  "localizedNames": [
    {
      "name": "racine",
      "locale": "fr"
    }
  ]
}

404: Not Found

{
    // Response
}

Delete a category tree

DELETE https://items.attraqt.io/category-trees/{name}/{version}

Path Parameters

Name	Type	Description
version*	number	Version of the category tree
name*	string	Category tree root name

Query Parameters

Name	Type	Description
tenant*	String
environment*	String

Headers

Name	Type	Description
Authorization*	string	Bearer token containing the following permission:

200

{}

400: Bad Request categoryTree used in catalog

{
    // Response
}

404: Not Found

{
    // Response
}

Api errors

Error category	Description
CATEGORY_TREE_NAME	Name is invalid
CATEGORY_TREE_LOCALE	Category tree contain a invalid locale or localized name
CATEGORY_TREE_LEAF	Category tree contain a invalid leaf or leaf name
CATEGORY_TREE_DELETION_USE	CategoryTree is currently used in a Catalog
CATEGORY_TREE_ALREADY_EXISTS	The category tree already exists, use update method
CATEGORY_TREE_NOT_FOUND	Impossible to update the category tree: category tree not exists