API documentation
Method list
Test your request
Changelog


addCategory
The method allows adding a category to the BaseLinker storage. Adding a category with the same ID again, updates the previously saved category.


Input parameters
storage_idvarchar(30)Storage ID in format "[type:bl|shop|warehouse]_[id:int]" (e.g. "shop_2445").
category_idintThe category identifier to be provided for updates. Should be left blank when creating a new category.
namevarchar(200)Category name
parent_idintThe parent category identifier obtained previously at the output of the addCategory method. Categories should be added starting from the hierarchy root so that the child is always added after the parent (you need to know the parent ID to add the child). For the top level category, 0 should be given as parent_id.



Output data
The method returns the data in JSON format.
statusvarchar(30)SUCCESS - request executed correctly
ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
storage_idvarchar(30)The identifier of the storage where the category has been added or modified in format "[type:bl|shop|warehouse]_[id:int]" (e.g. "shop_2445").
category_idintNumber of a category added or updated in BaseLinker storage. In an external application you should create a link between the internal number and the number received here. It will later be used to update the added category. This number is also used in addProducts and deleteCategory methods.



Sample
Input data:
Output data:
A sample request in PHP: