Attributes

Get Attributes Count

Method URL
POST /attributes/count

Body Params (formData)

Field Name Required / Optional
channel required
family required

Sample Request

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

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/attributes/count",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-API-token",
    "cache-control": "no-cache",
    "postman-token": "4e66858d-43a5-1d77-6b7d-3bf043ae936e"
  },
  "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": 121,
        "total_page": 13,
        "record_limit": "10"
    },
    "message": "Attribute count retrieved successfully."
}

{danger} Error Response

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

Get Attribute List

Method URL
POST /attributes

Body Params (formData)

Field Name Required / Optional
channel required
family required

Sample Request

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

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/attributes",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-API-token",
    "cache-control": "no-cache",
    "postman-token": "39001158-8692-16f3-dda4-0889aa89121e"
  },
  "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": "name",
            "status": 1,
            "is_required": null,
            "attribute_type": "text",
            "attribute_label": "Name",
            "default_value": "null",
            "is_unique": "0",
            "minimum_limit": null,
            "maximum_limit": null,
            "attribute_code": null,
            "maximum_characters": "null",
            "validation_rules": "0",
            "editor": null,
            "maximum_upload_size": null,
            "file_extension": null,
            "image_format": null,
            "is_decimal": null,
            "default_date": null,
            "past_date": null,
            "feature_date": null,
            "group_id": null
        },
        "1": {
            "id": 2,
            "code": "sku",
            "status": 1,
            "is_required": null,
            "attribute_type": "text",
            "attribute_label": "SKU",
            "default_value": "null",
            "is_unique": "0",
            "minimum_limit": null,
            "maximum_limit": null,
            "attribute_code": null,
            "maximum_characters": "null",
            "validation_rules": "0",
            "editor": null,
            "maximum_upload_size": null,
            "file_extension": null,
            "image_format": null,
            "is_decimal": null,
            "default_date": null,
            "past_date": null,
            "feature_date": null,
            "group_id": null
        },
        "count": {
            "total_count": 121,
            "total_page": 121
        }
    },
    "message": "Attribute retrieved successfully."
}

{danger} Error Response

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

Get Deleted Attribute List

Method URL
POST /attributes/deletedAttributes

Body Params (formData)

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

Sample Request

var form = new FormData();

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://client.flexipim.com/api/v2/attributes/deletedAttributes",
  "method": "POST",
  "headers": {
    "token": "your-flexiPIM-API-token",
    "cache-control": "no-cache",
    "postman-token": "191b8c65-8a51-f652-f2b6-c926eb0a2a6b"
  },
  "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": 18,
            "attribute_code": "Bigcommerce_Product_Type",
            "attribute_label": "Bigcommerce Product Type"
        },
        {
            "id": 99,
            "attribute_code": "L",
            "attribute_label": "Lamps"
        },
        {
            "id": 160,
            "attribute_code": "Color",
            "attribute_label": "Color"
        },
        {
            "id": 161,
            "attribute_code": "WEIGHT2",
            "attribute_label": "WEIGHT"
        }
    ],
    "message": "Deleted attributes retrieved successfully."
}

{danger} Error Response

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