Order Detail
This page describes the request data identifiers and response structure required to build an order detail page.
Data Identifier
{
"dataID": "GET_ORDER",
"order_key": "E477FEEBAABBCCDD208AFC505D20C022"
}
| Key | Description |
|---|---|
| dataID | Data identifier GET_ORDER |
| order_key | Order key (recommended) |
| order_seq | Order number (when no order_key) |
HTML
<div class="card">
<div class="card-header d-flex justify-content-between">
<strong>{{ o.order_no }}</strong>
<span>{{ o.summary_status }} · {{ o.payment_status }}</span>
</div>
<div class="card-body">
<p class="mb-1">{{ customer.name }} · {{ customer.phone }}</p>
<p class="text-secondary">{{ ship.receiver }}, {{ ship.address1 }} {{ ship.address2 }}</p>
<table class="table align-middle">
<tbody>
<tr v-for="it in o.items">
<td>{{ it.product_name }}</td>
<td>{{ it.item_status }}</td>
<td class="text-end">{{ it.quantity }}</td>
<td class="text-end">{{ it.line_total }}</td>
</tr>
</tbody>
</table>
<div class="text-end fw-bold">Total {{ o.grand_total }} {{ o.currency }}</div>
</div>
</div>
Response Result
{
"order": {
"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",
"items": [
{
"seq": 501,
"order_seq": 123,
"product_seq": 340,
"variant_seq": 5001,
"item_status": "SHIPPED",
"product_code": "TS-TS01",
"sku": "TS-TS01-WHT-V103",
"product_name": "Cotton T-Shirt",
"option_snapshot": "[{\"set_seq\":12,\"set_type\":\"COMBO\",\"set_label\":\"Color / Size\",\"variant_seq\":5001,\"option_text\":\"White \\/ S\",\"text_values\":null,\"price_delta\":0,\"group\":\"Color / Size\",\"value\":\"White \\/ S\"}]",
"product_snapshot": "{\"product_seq\":340,\"product_code\":\"TS-TS01\",\"name\":\"Cotton T-Shirt\",\"brand\":\"H:Dev+\",\"currency\":\"KRW\",\"base_price\":19000,\"variant_seq\":5001,\"price_override\":null}",
"item_extra_data": null,
"quantity": 2,
"unit_price": 19000,
"line_total": 38000,
"carrier_code": "CJ",
"tracking_number": "000000000000",
"shipped_at": "2026-10-04 02:57:38",
"delivered_at": null,
"create_date": "2026-10-04 11:57:37",
"order_item_key": "9A1C3F00B2D4E6F8A0B2C4D6E8F0A2B4",
"status_history": [
{
"seq": 9001,
"order_seq": 123,
"order_item_seq": 501,
"from_status": null,
"to_status": "RECEIVED",
"actor_seq": 3,
"reason_code": "ORDER_CREATED",
"reason_text": null,
"meta_data": null,
"create_date": "2026-10-04 11:57:37"
},
{
"seq": 9002,
"order_seq": 123,
"order_item_seq": 501,
"from_status": "RECEIVED",
"to_status": "PAID",
"actor_seq": 3,
"reason_code": "PAYMENT_CONFIRMED",
"reason_text": "Payment confirmed",
"meta_data": null,
"create_date": "2026-10-04 11:57:37"
},
{
"seq": 9003,
"order_seq": 123,
"order_item_seq": 501,
"from_status": "PAID",
"to_status": "PREPARING_SHIPMENT",
"actor_seq": 3,
"reason_code": null,
"reason_text": "Preparing shipment",
"meta_data": null,
"create_date": "2026-10-04 11:57:38"
},
{
"seq": 9004,
"order_seq": 123,
"order_item_seq": 501,
"from_status": "PREPARING_SHIPMENT",
"to_status": "SHIPPED",
"actor_seq": 3,
"reason_code": null,
"reason_text": null,
"meta_data": null,
"create_date": "2026-10-04 11:57:38"
}
],
"stock": [
{
"variant_seq": 5001,
"sku": "TS-TS01-WHT-V103",
"quantity": 2,
"stage": "SHIPPED"
}
]
}
]
}
}
| Key | Description |
|---|---|
| order | The order |
| order.seq | Order number |
| order.order_no | Order no ORD-YYYYMMDD-XXXXXX |
| order.order_key | Order key |
| order.source | Order channel |
| order.summary_status | Item status summary (MIXED if mixed) |
| order.payment_status | Payment status |
| order.currency | Currency code |
| order.item_subtotal | Item subtotal |
| order.shipping_total | Shipping fee |
| order.discount_total | Discount |
| order.tax_total | Tax |
| order.grand_total | Amount to pay |
| order.customer_snapshot | Customer (JSON string) |
| order.shipping_snapshot | Shipping address (JSON string) |
| order.order_extra_data | Extra data (JSON string) |
| order.admin_note | Admin note |
| order.create_date | Order date |
| order.items | Order items |
| order.items[n].seq | Item number. order_item_seq |
| order.items[n].item_status | Item status |
| order.items[n].product_name | Product name at order time |
| order.items[n].sku | SKU at order time |
| order.items[n].option_snapshot | Chosen options (JSON string) |
| order.items[n].quantity | Quantity |
| order.items[n].unit_price | Unit price (with options) |
| order.items[n].line_total | Line total |
| order.items[n].carrier_code | Carrier code |
| order.items[n].tracking_number | Tracking number |
| order.items[n].shipped_at | Shipped at |
| order.items[n].delivered_at | Delivered at |
| order.items[n].status_history | Status history |
| order.items[n].stock | Stock stages [{variant_seq, sku, quantity, stage}] |
- Screen example: an order-complete or my-order page calls with order_key from the URL. Show each item with name, options, quantity, amount, status and tracking, then the subtotal, shipping, discount and total.
- 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.
- order_key is the encrypted order number. Use order_key in page URLs and requests; keep order_seq for admin tools. When both are sent, order_key wins.
- 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.
- status_history lists item status changes (from_status, to_status, reason_code, reason_text, meta_data, create_date). stock[n].stage is RESERVED / SHIPPED / RELEASED / RESTOCKED.
- 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.
- 404 — Order not found. The order_key is wrong or the order was deleted.
- 400 — Both order_key and order_seq are empty.
Example
<script setup>
const route = useRoute()
const { output } = await useNuxtApp().$connector({ dataID: 'GET_ORDER', order_key: route.query.order_key })
const o = output.order
// Snapshots come as JSON strings
const parse = s => (s ? JSON.parse(s) : {})
const customer = parse(o.customer_snapshot)
const ship = parse(o.shipping_snapshot)
const options = it => (it.option_snapshot ? JSON.parse(it.option_snapshot) : [])
const money = v => new Intl.NumberFormat('ko-KR').format(v)
</script>
<template>
<div class="card">
<div class="card-header d-flex justify-content-between">
<strong>{{ o.order_no }}</strong>
<span>{{ o.summary_status }} · {{ o.payment_status }}</span>
</div>
<div class="card-body">
<p class="mb-1">{{ customer.name }} · {{ customer.phone }}</p>
<p class="text-secondary">{{ ship.receiver }}, {{ ship.address1 }} {{ ship.address2 }}</p>
<table class="table align-middle">
<thead><tr><th>Item</th><th>Status</th><th class="text-end">Qty</th><th class="text-end">Amount</th><th>Tracking</th></tr></thead>
<tbody>
<tr v-for="it in o.items" :key="it.seq">
<td>{{ it.product_name }}
<div class="small text-secondary" v-for="op in options(it)" :key="op.set_seq">{{ op.set_label }}: {{ op.option_text }}</div>
</td>
<td>{{ it.item_status }}</td>
<td class="text-end">{{ it.quantity }}</td>
<td class="text-end">{{ money(it.line_total) }}</td>
<td>{{ it.tracking_number ? it.carrier_code + ' ' + it.tracking_number : '-' }}</td>
</tr>
</tbody>
</table>
<div class="text-end">
<div>Items {{ money(o.item_subtotal) }} · Shipping {{ money(o.shipping_total) }} · Discount {{ money(o.discount_total) }}</div>
<div class="fw-bold">Total {{ money(o.grand_total) }} {{ o.currency }}</div>
</div>
</div>
</div>
</template>
<?php
$output = $connector->request(['dataID' => 'GET_ORDER', 'order_key' => $_GET['order_key']]);
if (!$output['result']) {
http_response_code(404); // 404 Order not found
return;
}
$o = $output['order'];
$ship = json_decode((string)$o['shipping_snapshot'], true) ?: []; // snapshots are JSON strings
?>
<h4><?= htmlspecialchars($o['order_no']) ?> <small><?= $o['summary_status'] ?> · <?= $o['payment_status'] ?></small></h4>
<p><?= htmlspecialchars(($ship['receiver'] ?? '') . ', ' . ($ship['address1'] ?? '')) ?></p>
<table class="table">
<?php foreach ($o['items'] as $it) { ?>
<tr>
<td><?= htmlspecialchars($it['product_name']) ?></td>
<td><?= $it['item_status'] ?></td>
<td class="text-end"><?= $it['quantity'] ?></td>
<td class="text-end"><?= number_format($it['line_total']) ?></td>
</tr>
<?php } ?>
</table>
<p class="text-end fw-bold">Total <?= number_format($o['grand_total']) ?> <?= $o['currency'] ?></p>
User Discussions
ADD- There are no posts yet.