Category hierarchies

Returns list of all category hierarchies in the system. Returned data can be limited with category_id and hierarchy_key query parameters.

Operations

Download hierarchies as JSON

Request

GET https://api.zoined.com/v2/download/hierarchies.json?limit=1000&offset=0&category_id=5401&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

category_idstring

Returns data of categories based on the given id

Example:category_id=5401

hierarchy_keystring

Returns data of given hierarchies only

Example:hierarchy_key=product

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

Responses

Request has been processed successfully.

Headers

Content-Type: application/json

Bodyapplication/json

hierarchy_namestringrequired

Hierarchy name

Example:"product"

category_idstringrequired

Category ID

Example:"123"

category_namestringrequired

Category name

Example:"Shoes"

parent_idstring

Category parent ID

Example:"12"

Response

{
  "hierarchy_name": "product",
  "category_id": "123",
  "category_name": "Shoes",
  "parent_id": "12"
}