Category

---

• Get Category Count
• Get Category List
• Get Child Category List
• Get Category Products
• Get Deleted Category List

Get Category Count

Method	URL
POST	/categories/count

Body Params (formData)

Field Name	Required / Optional
channel	required

Sample Request

var form = new FormData();
form.append("channel", "5");
form.append("rec_limit", "1");
form.append("page", "1");

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/categories/count",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-api-token",
    "cache-control": "no-cache",
    "postman-token": "5b9c4917-9f60-00a1-1497-ccd57fe5464e"
  },
  "processData": false,
  "contentType": false,
  "mimeType": "multipart/form-data",
  "data": form
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

{success} Success Response

{
    "success": true,
    "data": {
        "total_count": 32,
        "total_page": 32,
        "record_limit": "1"
    },
    "message": "Category count retrieved successfully."
}

{danger} Error Response

{
    "success": false,
    "message": "Error.",
    "data": "token required"
}

---

Get Category List

Method	URL
POST	/categories

Body Params (formData)

Field Name	Required / Optional
channel	required
language	optional
page	optional
rec_limit	optional

Sample Request

var form = new FormData();
form.append("channel", "2");
form.append("rec_limit", "1");
form.append("page", "1");

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/categories",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-api-token",
    "cache-control": "no-cache",
    "postman-token": "1f471024-0641-dde0-751c-08bb65a14ee2"
  },
  "processData": false,
  "contentType": false,
  "mimeType": "multipart/form-data",
  "data": form
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

{success} Success Response

{
    "success": true,
    "data": {
        "0": {
            "id": 3,
            "code": "rail_vehicles_toys",
            "image": "http://client.flexipim.com/assets/dckap/img/empty.svg",
            "parent_id": 2,
            "status": 0,
            "created_by": 1,
            "modified_by": 1,
            "created_at": "2019-09-06 09:35:15",
            "updated_at": "2020-02-19 16:21:27",
            "name": "Rail Vehicles",
            "level": 2
        },
        "count": {
            "total_count": 38,
            "total_page": 38
        }
    },
    "message": "Category retrieved successfully."
}

{danger} Error Response

{
    "success": false,
    "message": "Error.",
    "data": "token required"
}

---

Get Child Category List

Method	URL
POST	/categories/getChildCategories

Body Params (formData)

Field Name	Required / Optional
id	required
language	optional

Sample Request

var form = new FormData();
form.append("id", "1");

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/categories/getChildCategories",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-api-token",
    "cache-control": "no-cache",
    "postman-token": "e8f1295e-de31-4285-2f2d-c37226728158"
  },
  "processData": false,
  "contentType": false,
  "mimeType": "multipart/form-data",
  "data": form
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

{success} Success Response

{
    "success": true,
    "data": [
        {
            "id": 2,
            "code": "model_trains",
            "image": "http://client.flexipim.com/assets/dckap/img/empty.svg",
            "parent_id": 1,
            "status": 2,
            "created_by": 1,
            "modified_by": 1,
            "created_at": "2019-09-06 09:34:11",
            "updated_at": "2020-02-19 16:21:27",
            "name": "Model Trains & Railway Sets"
        }
    ],
    "message": "Sub-Category retrieved successfully."
}

{danger} Error Response

{
    "success": false,
    "message": "Error",
    "data": "Undefined index: token"
}

---

Get Category Products

Method	URL
POST	/categories/getCategoryProducts

Body Params (formData)

Field Name	Required / Optional
id	required
language	optional

Sample Request

var form = new FormData();
form.append("id", "2");

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/categories/getCategoryProducts",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-api-token",
    "cache-control": "no-cache",
    "postman-token": "275507b2-402b-ab4a-08b6-8c55519a698e"
  },
  "processData": false,
  "contentType": false,
  "mimeType": "multipart/form-data",
  "data": form
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

{success} Success Response

{
    "success": true,
    "data": [
        {
            "id": 1,
            "sku": "DCKAP0001",
            "name": "Hornby 2014 Catalogue"
        },
        {
            "id": 1995,
            "sku": "DCKAP11995",
            "name": "Tattoo Book: 280 Special Design Temporary Tattoos-Dragon"
        },
        {
            "id": 2001,
            "sku": "DCKAP12001",
            "name": "Zibits Power Lab Playset with Zibit"
        },
        {
            "id": 2736,
            "sku": "Testing",
            "name": "Testing"
        },
        {
            "id": 2787,
            "sku": "DCKAP167909",
            "name": "Preiser 30414 HYTorse Drawn Liquid Manure Wagon"
        },
        {
            "id": 2850,
            "sku": "2313",
            "name": "Test product"
        }
    ],
    "message": "Category products retrieved successfully."
}

{danger} Error Response

{
    "success": false,
    "message": "Error.",
    "data": "Category ID is required"
}

---

Get Deleted Category List

Method	URL
POST	/categories/deletedCategories

Sample Request

var form = new FormData();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/categories/deletedCategories",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-api-token",
    "cache-control": "no-cache",
    "postman-token": "fd4d188c-f541-47c8-b1c2-98054a43ae99"
  },
  "processData": false,
  "contentType": false,
  "mimeType": "multipart/form-data",
  "data": form
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

{success} Success Response

{
    "success": true,
    "data": [
        {
            "code": "hobbies",
            "id": 1,
            "name": "Hobbies"
        },
        {
            "code": "model_trains",
            "id": 2,
            "name": "Model Trains & Railway Sets"
        },
        {
            "code": "voltage_transformer",
            "id": 10,
            "name": "Voltage Transformer"
        },
        {
            "code": "bigcommerce_category",
            "id": 17,
            "name": "[bigcommerce_category]"
        },
        {
            "code": "AB",
            "id": 18,
            "name": "Abrasive Blasting Equipment"
        },
        {
            "code": "category_new",
            "id": 28,
            "name": "category_new"
        },
        {
            "code": "DC",
            "id": 43,
            "name": "DOG CARRIERS"
        },
        {
            "code": "shoes",
            "id": 51,
            "name": "Sports Shoe"
        },
        {
            "code": "watch",
            "id": 52,
            "name": "Watch"
        },
        {
            "code": "watch",
            "id": 53,
            "name": "Watch"
        },
        {
            "code": "new",
            "id": 54,
            "name": "[new]"
        }
    ],
    "message": "Deleted categories retrieved successfully."
}

{danger} Error Response

{
    "success": false,
    "message": "Error",
    "data": "Undefined index: token"
}