Plus - Category API

There is Swagger documentation available for this service

https://api.papirfly.app/category/swagger-ui/index.html

Swagger URL for SSO login (replace [com_id] with your company ID): 
https://api.papirfly.app/login?state=%2Fcategory%2Fswagger-ui%2Findex.html&p_com_id=[com_id]

Swagger URL for non-SSO login (replace [com_id] with your company ID twice): 
https://api.papirfly.app/mars/external.access?p_url=%2Flogin%3Fstate%3D%252Fcategory%252Fswagger-ui%252Findex.html%26p_com_id%3D[com_id]&p_com_id=[com_id]

Category service is used to retrieve category tree structure and details about categories. There are two different category trees available in our solution. There is one we call GLOBAL category tree and other one we call LOCAL category tree.

Global category tree

Global category tree is tied to a whole company and is available in all products inside that specific company and thus the only field which is tied to the categories in this tree is companyId

Local category tree

Local category tree is tied to a product and is available only for that specified product, most often it is a Place product. Therefore all categories in this category tree must have companyId, portalId and productId filled in.

Listing categories

Lists global categories for company with id 10930 and with texts for languageId 2
GET https://api.papirfly.app/category/v1/categories?categoryType=GLOBAL&companyId=10930&languageId=2 

Lists local categories for company with id 10930 and with texts for languageId 2
GET https://api.papirfly.app/category/v1/categories?categoryType=LOCAL&companyId=10930&languageId=2 

Creating categories

Create a GLOBAL category

POST https://api.papirfly.app/category/v1/categories 

{  
    "companyId": 10930, 
    "categoryType": "GLOBAL", 
    "texts": [ 
        { 
            "languageId": 2, 
            "title": "Category Name Update" 
        }     
    ] 
} 

Create a LOCAL category 

POST https://api.papirfly.app/category/v1/categories 

{  
    "companyId": 10930, 
    "portalId": 13225, 
    "productId": 80753, 
    "categoryType": "LOCAL", 
    "texts": [ 
        { 
            "languageId": 2, 
            "title": "Category Name Update" 
        }     
    ] 
} 

Create a child category

POST https://api.papirfly.app/category/v1/categories 

{ 
    "companyId": 10930, 
    "categoryType": "GLOBAL", 
    "parentId": <categoryId>,
    "texts": [ 
        { 
            "languageId": 2, 
            "title": "Category Name Update" 
        }     
    ] 
} 

Deleting categories

DELETE https://api.papirfly.app/category/v1/categories/{categoryId}