Group Attributes

Search…
Group Attributes
Manage Group Attributes Filter
List attributes group
get
‎
‎ https://<domain>/<api prefix>/<version>/commerce/product/list/attribute-groups/
Sample Code
Node
1
var request = require('request');
2
var options = {
3
  'method': 'GET',
4
  'url': '‎https://<domain>/<api prefix>/<version>/commerce/product/list/attribute-groups/',
5
  'headers': {
6
    'apikey': '<apikey>',
7
    'Authorization': 'Bearer <access token>'
8
  }
9
};
10
request(options, function (error, response) {
11
  if (error) throw new Error(error);
12
  console.log(response.body);
13
});
14
​
Copied!
PHP
1
<?php
2
​
3
$curl = curl_init();
4
​
5
curl_setopt_array($curl, array(
6
  CURLOPT_URL => "‎https://<domain>/<api prefix>/<version>/commerce/product/list/attribute-groups/",
7
  CURLOPT_RETURNTRANSFER => true,
8
  CURLOPT_ENCODING => "",
9
  CURLOPT_MAXREDIRS => 10,
10
  CURLOPT_TIMEOUT => 0,
11
  CURLOPT_FOLLOWLOCATION => true,
12
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13
  CURLOPT_CUSTOMREQUEST => "GET",
14
  CURLOPT_HTTPHEADER => array(
15
    "apikey: <apikey>",
16
    "Authorization: Bearer <access token>",
17
  ),
18
));
19
​
20
$response = curl_exec($curl);
21
​
22
curl_close($curl);
23
echo $response;
Copied!
Create attributes group
post
‎
‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎https://<domain>/<api prefix>/<version>/commerce/product/create/attribute-groups/
Sample Code
Node
1
var request = require('request');
2
var options = {
3
  'method': 'POST',
4
  'url': 'https://<domain>/<api prefix>/<version>/commerce/product/create/attribute-groups/',
5
  'headers': {
6
    'apikey': '<apikey>',
7
    'Authorization': 'Bearer <access token>',
8
  },
9
  body: JSON.stringify({"name":"<name>","attribute_id":["<attribute_id>","<attribute_id>",...]})
10
​
11
};
12
request(options, function (error, response) {
13
  if (error) throw new Error(error);
14
  console.log(response.body);
15
});
Copied!
PHP
1
<?php
2
​
3
$curl = curl_init();
4
​
5
curl_setopt_array($curl, array(
6
  CURLOPT_URL => 'https://<domain>/<api prefix>/<version>/commerce/product/create/attribute-groups/',
7
  CURLOPT_RETURNTRANSFER => true,
8
  CURLOPT_ENCODING => '',
9
  CURLOPT_MAXREDIRS => 10,
10
  CURLOPT_TIMEOUT => 0,
11
  CURLOPT_FOLLOWLOCATION => true,
12
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13
  CURLOPT_CUSTOMREQUEST => 'POST',
14
  CURLOPT_POSTFIELDS =>'{
15
    "name":"<name>",
16
    "attribute_id": ["<attribute_id>","<attribute_id>"]
17
}',
18
  CURLOPT_HTTPHEADER => array(
19
    'apikey: <apikey>',
20
    'Authorization: Bearer <access token>',
21
  ),
22
));
23
​
24
$response = curl_exec($curl);
25
​
26
curl_close($curl);
27
echo $response;
Copied!
Error Responses
Status Code
Error Type
Field
Description
400
Validation Error
name
This field is required.
This field may not be blank.
Ensure this field has no more than 20 characters.
400
Validation Error
attribute_id
Attribute id is required.
attribute_id is not valid or This field may not be blank.
attribute_id is not exist.
Update attributes group
post
‎
‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎https://<domain>/<api prefix>/<version>/commerce/product/update/attribute-groups/
Sample Code
Node
1
var request = require('request');
2
var options = {
3
  'method': 'POST',
4
  'url': '‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎https://<domain>/<api prefix>/<version>/commerce/product/update/attribute-groups/',
5
  'headers': {
6
    'apikey': '<apikey>',
7
    'Authorization': 'Bearer <access token>',
8
  },
9
  body: JSON.stringify({"attrgroup_id":"<attrgroup_id>","name":"<name>","add_attr":["<attr_id>","<attr_id>",...],"remove_attr":["<attr_id>","<attr_id>",...]})
10
​
11
};
12
request(options, function (error, response) {
13
  if (error) throw new Error(error);
14
  console.log(response.body);
15
});
16
​
Copied!
PHP
1
<?php
2
​
3
$curl = curl_init();
4
​
5
curl_setopt_array($curl, array(
6
  CURLOPT_URL => '‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎‎https://<domain>/<api prefix>/<version>/commerce/product/update/attribute-groups/',
7
  CURLOPT_RETURNTRANSFER => true,
8
  CURLOPT_ENCODING => '',
9
  CURLOPT_MAXREDIRS => 10,
10
  CURLOPT_TIMEOUT => 0,
11
  CURLOPT_FOLLOWLOCATION => true,
12
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
13
  CURLOPT_CUSTOMREQUEST => 'POST',
14
  CURLOPT_POSTFIELDS =>'{
15
    "attrgroup_id":"<attrgroup_id>",
16
    "name":"<name>",
17
    "add_attr": ["<attr_id>","<attr_id>",...],
18
    "remove_attr": ["<attr_id>","<attr_id>",...]
19
}',
20
  CURLOPT_HTTPHEADER => array(
21
    'apikey: <apikey>',
22
    'Authorization: Bearer <access token>',
23
  ),
24
));
25
​
26
$response = curl_exec($curl);
27
​
28
curl_close($curl);
29
echo $response;
Copied!
Error Responses
Status Code
Error Type
Field
Description
400
Invalid Input
attrgroup_id
This field is required.
attrgroup_id is not valid or This field may not be blank
400
Validation Error
name
This field is required.
This field may not be blank.
Ensure this field has no more than 20 characters.
400
Validation Error
attribute_id
<attribute_id>  is not valid or This field may not be blank.
<attribute_id>  is not exist.
<attribute_id> is already exist in group.
​
Enrollment Packages
Product Attribute
Last modified 1mo ago
Copy link
Contents
List attributes group
get
Create attributes group
post
Update attributes group
post