Flat hierarchies

Returns list of all hierarchies in the system in a flat format. Returned data can be limited with hierarchy_key query parameters.

Operations

Download flat hierarchies as JSON

Request

GET https://api.zoined.com/v2/download/flatHierarchies.json?limit=1000&offset=0&hierarchy_key=product

Security

bearerAuth

Query

limitnumber

How many entries to return

Example:limit=1000

offsetnumber

Which offset to return data from

Example:offset=0

hierarchy_keystring

Returns data of given hierarchies only

Example:hierarchy_key=product

curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/flatHierarchies.json?limit=1000&offset=0&hierarchy_key=product' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

Content-Type: application/json

Bodyapplication/json

hierarchy_keystringrequired

Type of hierarchy that is uploaded

Enum Value	Description
product	Product category hierarchy
model	Product model hierarchy
product_group	Product group hierarchy
organisation	Organisation hierarchy
customer	Customer hierarchy
channel	Channel hierarchy
area	Area hierarchy
account	Bookkeeping account hierarchy

Example:"product"

entity_idstringrequired

Identifier for the lowest level entity in the hierarchy

Example:"XYZ"

level1stringrequired

Name of root category level

Example:"Clothing"

level2string

Name of category level 2

Example:"Children's clothing"

level3string

Name of category level 3

Example:"Children's outdoor clothing"

level4string

Name of category level 4

Example:"Children's outdoor headwear"

level5string

Name of category level 5

Example:"Children's caps"

level6string

Name of category level 6

Example:"Children's small caps"

level7string

Name of category level 7

Example:"Children's themed caps"

level8string

Name of category level 8

Example:"Children's disney caps"

level9string

Name of category level 9

Example:"Children's mickey caps"

level10string

Name of category level 10

Example:"Children's ..."

Response

{
  "hierarchy_key": "product",
  "entity_id": "XYZ",
  "level1": "Clothing",
  "level2": "Children's clothing",
  "level3": "Children's outdoor clothing",
  "level4": "Children's outdoor headwear",
  "level5": "Children's caps",
  "level6": "Children's small caps",
  "level7": "Children's themed caps",
  "level8": "Children's disney caps",
  "level9": "Children's mickey caps",
  "level10": "Children's ..."
}