Order List
This page describes the request data identifiers and response structure required to build an order list page.
Data Identifier
{
"dataID": "GET_ORDER_LIST",
"page": 1,
"list_per_page": 20,
"block_per_page": 5,
"page_link_url": "/console/order/list",
"page_link_hash": "",
"status_group": "paid",
"search_keyword": "",
"date_from": "2026-10-01",
"date_to": "2026-10-31",
"sort": "desc"
}
| Key | Description |
|---|---|
| dataID | Data identifier GET_ORDER_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_group | Tab: pending / paid / preparing / shipping / delivered / claim |
| summary_status | Exact order summary status |
| item_status | Orders with an item in this status |
| overdue | 1 = item_status held too long |
| payment_status | Payment status |
| customer_seq | Member number |
| source | Order channel |
| order_no | Exact order no |
| search_keyword | 2+ chars. Order no, name, phone, product |
| date_from | From YYYY-MM-DD |
| date_to | To YYYY-MM-DD |
| sort | Order date sort desc (default) / asc |
HTML
<ul class="nav nav-tabs">
<li class="nav-item" v-for="t in tabs">
<a href="#" class="nav-link">{{ t }} {{ output.summary_counts[t] }}</a>
</li>
</ul>
<table class="table align-middle">
<tbody>
<tr v-for="o in output.order_list">
<td><a :href="'/console/order/view?order_key=' + o.order_key">{{ o.order_no }}</a></td>
<td>{{ o.customer_name }}</td>
<td>{{ o.first_item_name }}</td>
<td>{{ o.summary_status }} · {{ o.payment_status }}</td>
<td class="text-end">{{ o.grand_total }}</td>
</tr>
</tbody>
</table>
Response Result
{
"pagination": {
"total_result_num": 1,
"total_page_num": 1,
"page": "1",
"start_page": 1,
"end_page": 1,
"prev_page": 1,
"next_page": 1
},
"order_list": [
{
"seq": 123,
"order_no": "ORD-20261004-CAA73C",
"customer_seq": null,
"source": "WEB",
"summary_status": "SHIPPED",
"payment_status": "PAID",
"currency": "KRW",
"item_subtotal": 38000,
"shipping_total": 2500,
"discount_total": 0,
"tax_total": 0,
"grand_total": 40500,
"customer_snapshot": "{\"name\":\"Jane Kim\",\"email\":\"jane.kim@example.com\",\"phone\":\"010-0000-0000\"}",
"shipping_snapshot": "{\"receiver\":\"Jane Kim\",\"zipcode\":\"00000\",\"address1\":\"123 Teheran-ro, Gangnam-gu, Seoul\",\"address2\":\"Apt 101\"}",
"order_extra_data": null,
"admin_note": "Gift wrap requested",
"create_date": "2026-10-04 11:57:37",
"order_key": "E477FEEBAABBCCDD208AFC505D20C022",
"item_count": 1,
"customer_name": "Jane Kim",
"customer_phone": "010-0000-0000",
"first_item_name": "Cotton T-Shirt"
}
],
"total_count": 1,
"summary_counts": {
"all": 1,
"pending": 0,
"paid": 0,
"preparing": 0,
"shipping": 1,
"delivered": 0,
"claim": 0,
"mixed": 0
}
}
| Key | Description |
|---|---|
| order_list | Orders |
| order_list[n].order_key | Order key (for detail links) |
| order_list[n].order_no | Order no |
| order_list[n].summary_status | Item status summary |
| order_list[n].payment_status | Payment status |
| order_list[n].grand_total | Amount to pay |
| order_list[n].item_count | Number of items |
| order_list[n].first_item_name | First item name |
| order_list[n].customer_name | Customer name (customer_snapshot.name) |
| order_list[n].customer_phone | Customer phone (customer_snapshot.phone) |
| order_list[n].create_date | Order date |
| pagination | Paging info |
| total_count | Total orders matching the filter |
| summary_counts | Order counts by tab |
- Screen example (admin order list): show tabs with counts from summary_counts (all, pending, paid, preparing, shipping, delivered, claim) and call again with status_group when a tab is clicked. Link the order no to the detail page with order_key.
- status_group: pending = RECEIVED and PAYMENT_PENDING, paid = PAID, preparing = PREPARING_SHIPMENT, shipping = SHIPPED, delivered = DELIVERED, claim = every cancel, return and exchange status. summary_counts has all, each tab and mixed (orders with mixed item statuses).
- overdue=1 works with item_status. Thresholds: PAYMENT_PENDING 3 days, PAID 2 days, PREPARING_SHIPMENT 2 days, CANCEL / RETURN / EXCHANGE_REQUESTED 1 day.
- customer_snapshot, shipping_snapshot, order_extra_data, option_snapshot and product_snapshot come as JSON strings. JSON.parse them before use. List search looks at name and phone in customer_snapshot.
- summary_status summarizes the item statuses: the shared status when all items match, otherwise MIXED. The server recalculates it after every item change, so never send it.
- Error codes — errors also come back as HTTP 200. Check result:false, then error_code (string) and error_message.
- 401 — Login required. Every order API needs a signed-in session.
- A 1-character search_keyword or an unknown status_group is ignored. With no match, order_list is an empty array.
Example
| Order no | Customer | Item | Status | Total | Date |
|---|---|---|---|---|---|
| ORD-20261004-CAA73C | Jane Kim | Cotton T-Shirt | SHIPPED · PAID | 40,500 | 2026-10-04 11:57:37 |
1 orders
<script setup>
import { ref } from 'vue'
const tabs = ['all', 'pending', 'paid', 'preparing', 'shipping', 'delivered', 'claim']
const tab = ref('all')
const keyword = ref('')
const output = ref({ order_list: [], summary_counts: {} })
const money = v => new Intl.NumberFormat('ko-KR').format(v)
async function load(page = 1) {
const res = await useNuxtApp().$connector({
dataID: 'GET_ORDER_LIST', page, list_per_page: 20, page_link_url: '/console/order/list', page_link_hash: '',
status_group: tab.value === 'all' ? '' : tab.value,
search_keyword: keyword.value, // 2+ characters: order no, customer name, phone, product name
sort: 'desc'
})
output.value = res.output
}
await load()
</script>
<template>
<ul class="nav nav-tabs">
<li class="nav-item" v-for="t in tabs" :key="t">
<a href="#" class="nav-link" :class="{ active: tab === t }" @click.prevent="tab = t; load()">
{{ t }} {{ output.summary_counts[t] ?? 0 }}
</a>
</li>
</ul>
<form class="d-flex gap-2 my-3" @submit.prevent="load()">
<input class="form-control" v-model="keyword" placeholder="Order no, name, phone, product">
<button class="btn btn-primary">Search</button>
</form>
<table class="table align-middle">
<thead><tr><th>Order no</th><th>Customer</th><th>Item</th><th>Status</th><th class="text-end">Total</th><th>Date</th></tr></thead>
<tbody>
<tr v-for="o in output.order_list" :key="o.seq">
<td><NuxtLink :to="`/console/order/view?order_key=${o.order_key}`">{{ o.order_no }}</NuxtLink></td>
<td>{{ o.customer_name }}</td>
<td>{{ o.first_item_name }}<span v-if="o.item_count > 1"> +{{ o.item_count - 1 }}</span></td>
<td>{{ o.summary_status }} · {{ o.payment_status }}</td>
<td class="text-end">{{ money(o.grand_total) }}</td>
<td>{{ o.create_date }}</td>
</tr>
</tbody>
</table>
<p class="text-secondary">{{ output.total_count }} orders</p>
</template>
<?php
$output = $connector->request([
'dataID' => 'GET_ORDER_LIST',
'page' => $_GET['page'] ?? 1,
'list_per_page' => 20,
'page_link_url' => '/console/order/list',
'page_link_hash' => '',
'status_group' => $_GET['tab'] ?? '', // pending / paid / preparing / shipping / delivered / claim
'search_keyword' => $_GET['q'] ?? '', // 2+ characters
'sort' => 'desc',
]);
?>
<p>All <?= $output['summary_counts']['all'] ?> · Shipping <?= $output['summary_counts']['shipping'] ?></p>
<table class="table">
<?php foreach ($output['order_list'] as $o) { ?>
<tr>
<td><a href="/console/order/view?order_key=<?= $o['order_key'] ?>"><?= htmlspecialchars($o['order_no']) ?></a></td>
<td><?= htmlspecialchars((string)$o['customer_name']) ?></td>
<td><?= htmlspecialchars((string)$o['first_item_name']) ?></td>
<td><?= $o['summary_status'] ?> · <?= $o['payment_status'] ?></td>
<td class="text-end"><?= number_format($o['grand_total']) ?></td>
</tr>
<?php } ?>
</table>
User Discussions
ADD- There are no posts yet.