Families

Get Family Count

Method URL
POST /families/count

Sample Request

var form = new FormData();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/families/count",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-api-token",
    "cache-control": "no-cache",
    "postman-token": "300a75b5-c779-418b-0d25-3c20ae660a05"
  },
  "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": 11,
        "total_page": 2,
        "record_limit": "10"
    },
    "message": "Families count retrieved successfully."
}

{danger} Error Response

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

Get Family List

Method URL
POST /families

Body Params (formData)

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

Sample Request

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

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/families",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-api-token",
    "cache-control": "no-cache",
    "postman-token": "137d073e-e817-f487-6a7c-416040ea01b2"
  },
  "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": 1,
            "code": "amazon_hobbies_family",
            "sort_order": 1,
            "created_by": 1,
            "updated_by": 1,
            "status": 0,
            "created_at": "2019-09-06 09:49:51",
            "updated_at": "2020-02-14 15:47:28",
            "name": "Amazon Hobbies Family Sets"
        },
        "count": {
            "total_count": 11,
            "total_page": 11
        }
    },
    "message": "Families retrieved successfully."
}

{danger} Error Response

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

Get Family Attribute Group List

Method URL
POST /families/getAttributesGroup

Body Params (formData)

Field Name Required / Optional
id required
channel 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/families/getAttributesGroup",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-api-token",
    "cache-control": "no-cache",
    "postman-token": "3457424d-ca7c-f832-260d-7308df10eedb"
  },
  "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": "Seo",
            "status": 1,
            "sort_order": 2,
            "created_by": 1,
            "modified_by": 1,
            "created_at": "2019-09-06 06:39:29",
            "updated_at": "2019-09-06 06:39:29",
            "is_display": 1,
            "name": "Seo"
        },
        {
            "id": 3,
            "code": "toys_sets",
            "status": 1,
            "sort_order": 3,
            "created_by": 1,
            "modified_by": 1,
            "created_at": "2019-09-06 09:48:53",
            "updated_at": "2020-01-27 16:59:19",
            "is_display": 1,
            "name": "Toy Sets"
        },
        {
            "id": 4,
            "code": "Bigcommerce",
            "status": 1,
            "sort_order": 4,
            "created_by": 1,
            "modified_by": 1,
            "created_at": "2019-09-06 12:28:23",
            "updated_at": "2019-09-06 12:28:23",
            "is_display": 1,
            "name": "Bigcommerce"
        },
        {
            "id": 15,
            "code": "MI",
            "status": 1,
            "sort_order": 15,
            "created_by": 1,
            "modified_by": 1,
            "created_at": "2019-09-18 10:34:49",
            "updated_at": "2019-09-18 10:34:49",
            "is_display": 1,
            "name": "More Information"
        },
        {
            "id": 20,
            "code": "analog_output:",
            "status": 1,
            "sort_order": 20,
            "created_by": 1,
            "modified_by": 1,
            "created_at": "2019-09-25 10:47:16",
            "updated_at": "2019-09-25 10:47:16",
            "is_display": 1,
            "name": "Analog output:"
        }
    ],
    "message": "Families Attribute Groups retrieved successfully."
}

{danger} Error Response

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

Get Family Attribute List

Method URL
POST /families/getAttributes

Body Params (formData)

Field Name Required / Optional
id required
channel required
language optional

Sample Request

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

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/families/getAttributes",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-api-token",
    "cache-control": "no-cache",
    "postman-token": "eba88554-48ca-0a88-9a17-2e284425c073"
  },
  "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": 5,
            "attribute_code": "meta_description",
            "status": 1,
            "is_language_global": 0,
            "is_display": 1,
            "pim_attribute_input_field_id": 3,
            "is_required": 0,
            "custom_fields": "{\u0022is_editor_option\u0022:\u00221\u0022,\u0022maximum_characters\u0022:null}",
            "created_by": 1,
            "updated_by": 1,
            "created_at": "2019-09-06 06:39:29",
            "updated_at": "2019-09-18 11:21:10",
            "attribute_label": "[meta_description]"
        },
        {
            "id": 8,
            "attribute_code": "price",
            "status": 1,
            "is_language_global": 0,
            "is_display": 1,
            "pim_attribute_input_field_id": 8,
            "is_required": 0,
            "custom_fields": "{\u0022minimum_limit\u0022:null,\u0022maximum_limit\u0022:null,\u0022default_value\u0022:null,\u0022is_decimal\u0022:\u00220\u0022}",
            "created_by": 1,
            "updated_by": 1,
            "created_at": "2019-09-06 09:36:46",
            "updated_at": "2019-09-06 09:36:46",
            "attribute_label": "Price"
        }
   ],
    "message": "Families Attributes retrieved successfully."
}

{danger} Error Response

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

Get Group Attribute List

Method URL
POST /families/getAttributesListUsingAttributeGroup

Body Params (formData)

Field Name Required / Optional
id required (Attribute Group ID)
channel required
language optional

Sample Request

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

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/families/getAttributesListUsingAttributeGroup",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-api-token",
    "cache-control": "no-cache",
    "postman-token": "65df39e8-4ecc-d47d-6ce4-d00d45c915c8"
  },
  "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,
            "attribute_code": "name",
            "status": 1,
            "is_language_global": 0,
            "is_display": 0,
            "pim_attribute_input_field_id": 2,
            "is_required": 0,
            "custom_fields": "{\u0022maximum_characters\u0022:null,\u0022validation_rules\u0022:\u00220\u0022,\u0022default_value\u0022:null,\u0022is_unique\u0022:\u00220\u0022}",
            "created_by": 1,
            "updated_by": 1,
            "created_at": "2019-09-06 06:39:29",
            "updated_at": "2019-09-06 06:39:29",
            "attribute_label": "Name"
        },
        {
            "id": 2,
            "attribute_code": "sku",
            "status": 1,
            "is_language_global": 0,
            "is_display": 0,
            "pim_attribute_input_field_id": 2,
            "is_required": 0,
            "custom_fields": "{\u0022maximum_characters\u0022:null,\u0022validation_rules\u0022:\u00220\u0022,\u0022default_value\u0022:null,\u0022is_unique\u0022:\u00220\u0022}",
            "created_by": 1,
            "updated_by": 1,
            "created_at": "2019-09-06 06:39:29",
            "updated_at": "2019-09-06 06:39:29",
            "attribute_label": "SKU"
        },
        {
            "id": 3,
            "attribute_code": "description",
            "status": 1,
            "is_language_global": 0,
            "is_display": 0,
            "pim_attribute_input_field_id": 3,
            "is_required": 0,
            "custom_fields": "{\u0022maximum_characters\u0022:null,\u0022validation_rules\u0022:\u00220\u0022,\u0022default_value\u0022:null,\u0022is_unique\u0022:\u00220\u0022}",
            "created_by": 1,
            "updated_by": 1,
            "created_at": "2019-09-06 06:39:29",
            "updated_at": "2019-09-06 06:39:29",
            "attribute_label": "[description]"
        }
    ],
    "message": "Group Attributes retrieved successfully."
}

{danger} Error Response

{
    "success": false,
    "message": "Error.",
    "data": "Attribute Group Id Required"
}

Get Deleted Family List

Method URL
POST /products/deletedFamilies

Sample Request

var form = new FormData();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/families/deletedFamilies",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-api-token",
    "cache-control": "no-cache",
    "postman-token": "606c611a-cdb9-c37e-2662-42709ec1371b"
  },
  "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": 12,
            "code": "sample_family_one",
            "name": "Sample Family One"
        }
    ],
    "message": "Deleted families retrieved successfully."
}

{danger} Error Response

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