Option Group List
This page describes the request data identifiers and response structure required to list reusable option groups.
Data Identifier
{
"dataID": "GET_OPTION_GROUP_LIST",
"page": 1,
"list_per_page": 20,
"block_per_page": 5,
"page_link_url": "/commerce/option-group/list",
"page_link_hash": "",
"status": "ACTIVE",
"search_keyword": "",
"sort": "desc"
}
| Key | Description |
|---|---|
| dataID | Data identifier GET_OPTION_GROUP_LIST |
| page | Page number |
| list_per_page | Rows per page (default 20) |
| block_per_page | Page links per block (default 7) |
| page_link_url | Base URL for pagination links |
| page_link_hash | Hash appended to pagination links |
| status | ACTIVE / INACTIVE |
| search_keyword | Search on code and name |
| sort | Order by seq asc / desc (default desc) |
HTML
<div class="card shadow-sm">
<div class="card-header"><strong>Option groups</strong> <span class="text-secondary">({{ output.total_option_group_count }})</span></div>
<ul class="list-group list-group-flush">
<li class="list-group-item" v-for="g in output.option_group_list">
<div class="d-flex justify-content-between"><strong>{{ g.name }}</strong><code>{{ g.code }}</code></div>
<div class="mt-2">
<span class="badge bg-light text-dark me-1" v-for="v in g.option_values">{{ v.label }}</span>
</div>
</li>
</ul>
</div>
Response Result
{
"search_keyword": "TEST_DOCS",
"pagination": {
"total_result_num": 1,
"total_page_num": 1,
"page": "1",
"start_page": 1,
"end_page": 1,
"prev_page": 1,
"next_page": 1
},
"option_group_list": [
{
"seq": 10,
"code": "COLOR",
"name": "Color",
"status": "ACTIVE",
"stock_flg": 1,
"variant_use_count": 0,
"product_use_count": 0,
"option_values": [
{
"seq": 111,
"option_group_seq": 10,
"code": "WHT",
"label": "White",
"price_delta": 0,
"sort_order": 0,
"status": "ACTIVE"
},
{
"seq": 112,
"option_group_seq": 10,
"code": "BLK",
"label": "Black",
"price_delta": 1000,
"sort_order": 1,
"status": "ACTIVE"
}
]
}
],
"total_option_group_count": 1
}
| Key | Description |
|---|---|
| option_group_list | Option groups |
| option_group_list[n].seq | Option group number (option_group_seq) |
| option_group_list[n].code | Group code |
| option_group_list[n].name | Group name |
| option_group_list[n].status | ACTIVE / INACTIVE |
| option_group_list[n].stock_flg | Track stock 0 / 1 |
| option_group_list[n].variant_use_count | Option rows using its values |
| option_group_list[n].product_use_count | Products using the group |
| option_group_list[n].option_values | Values |
| option_group_list[n].option_values[n].seq | Value number |
| option_group_list[n].option_values[n].code | Value code (used in SKUs) |
| option_group_list[n].option_values[n].label | Display label |
| option_group_list[n].option_values[n].price_delta | Default extra amount |
| option_group_list[n].option_values[n].sort_order | Sort order |
| pagination | Paging info |
| total_option_group_count | Total groups |
- An option group is a reusable template such as Color. Pick it with option_group_seq in APPLY_OPTION_SET and its values and price_delta are copied into the product options.
- Error codes — errors also come back as HTTP 200. Check result:false, then error_code (string) and error_message.
- This read API needs no sign-in.
<script setup>
const { output } = await useNuxtApp().$connector({
dataID: 'GET_OPTION_GROUP_LIST', page: 1, list_per_page: 20, status: 'ACTIVE', sort: 'desc'
})
</script>
<template>
<div class="card shadow-sm">
<div class="card-header"><strong>Option groups</strong> <span class="text-secondary">({{ output.total_option_group_count }})</span></div>
<ul class="list-group list-group-flush">
<li class="list-group-item" v-for="g in output.option_group_list" :key="g.seq">
<div class="d-flex justify-content-between">
<strong>{{ g.name }}</strong><code>{{ g.code }}</code>
</div>
<div class="mt-2">
<span class="badge bg-light text-dark me-1" v-for="v in g.option_values" :key="v.seq">{{ v.label }}</span>
</div>
</li>
</ul>
</div>
</template>
<?php
$requestData = [
'dataID' => 'GET_OPTION_GROUP_LIST',
'page' => 1,
'list_per_page' => 20,
'status' => 'ACTIVE',
'sort' => 'desc',
];
$output = $connector->request($requestData);
foreach ($output['option_group_list'] as $g) {
echo '<h6>' . htmlspecialchars($g['name']) . ' (' . $g['code'] . ')</h6>';
foreach ($g['option_values'] as $v) {
echo '<span class="badge bg-light text-dark">' . htmlspecialchars($v['label']) . '</span> ';
}
}
Related Links
User Discussions
ADD- There are no posts yet.