Update Order Item Shipping

This page describes the request data identifiers and response structure required to set per-item shipping (tracking) information.

Data Identifier

{
  "dataID": "UPDATE_ORDER_ITEM_SHIPPING",
  "order_item_seq": 501,
  "carrier_code": "CJ",
  "tracking_number": "000000000000",
  "shipped_at": "2026-10-04 11:57:38",
  "delivered_at": null
}
KeyDescription
dataIDData identifier UPDATE_ORDER_ITEM_SHIPPING
order_item_seqItem number (order.items[n].seq)
carrier_codeCarrier code, e.g. CJ
tracking_numberTracking number
shipped_atShipped at YYYY-MM-DD HH:MM:SS
delivered_atDelivered at

HTML

<form id="frm_update_order_item_shipping">
  <input type="hidden" name="order_item_seq" value="700501">
  <select name="carrier_code"><option>CJ</option><option>HANJIN</option><option>LOTTE</option><option>EMS</option></select>
  <input name="tracking_number" value="1234567890123">
  <input name="shipped_at" value="2026-10-16 10:05:00">
  <input name="delivered_at" value="">
  <button type="submit" class="btn btn-primary">Save tracking</button>
</form>

Response Result

{
  "result": true,
  "result_code": 200,
  "order_item_seq": 501
}
KeyDescription
resultSaved or not (true / false)
result_code200 on success
order_item_seqItem number
  • Screen example: enter carrier and tracking number on the item row, save, then move the item to SHIPPED with Change item status. This API changes neither status nor stock.
  • 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.
  • 400 — order_item_seq is empty.
  • 404 — Order item not found.

Example

Shipping details

Item TS-TS01-WHT-V103 (#501)

<script setup>
import { ref } from 'vue'
// Per-item shipping details (independent of the status transition).
const form = ref({ order_item_seq: 501, carrier_code: 'CJ', tracking_number: '1234567890123', shipped_at: '2026-10-16 10:05:00', delivered_at: '' })
const msg = ref('')
async function save() {
  const { output } = await useNuxtApp().$connector({ dataID: 'UPDATE_ORDER_ITEM_SHIPPING', ...form.value })
  msg.value = output.result ? 'Tracking saved' : 'Save failed'
}
</script>

<template>
  <form class="card shadow-sm p-4" @submit.prevent="save">
    <h5 class="mb-1">Shipping details</h5>
    <p class="text-secondary">Item <code>TS-TS01-WHT-V103</code> (#{{ form.order_item_seq }})</p>
    <div class="row g-3">
      <div class="col-md-3">
        <label class="form-label">Carrier</label>
        <select class="form-select" v-model="form.carrier_code"><option>CJ</option><option>HANJIN</option><option>LOTTE</option><option>EMS</option></select>
      </div>
      <div class="col-md-5"><label class="form-label">Tracking number</label><input class="form-control" v-model="form.tracking_number"></div>
      <div class="col-md-4"><label class="form-label">Shipped at</label><input class="form-control" v-model="form.shipped_at"></div>
    </div>
    <button class="btn btn-primary mt-3">Save tracking</button>
    <p class="mt-2 text-success">{{ msg }}</p>
  </form>
</template>
<?php
$requestData = [
    'dataID'          => 'UPDATE_ORDER_ITEM_SHIPPING',
    'order_item_seq'  => 501,
    'carrier_code'    => 'CJ',
    'tracking_number' => '1234567890123',
    'shipped_at'      => '2026-10-16 10:05:00',
    'delivered_at'    => null,        // set when the parcel is delivered
];
$output = $connector->request($requestData);

echo $output['result'] ? 'Tracking saved for item #' . $output['order_item_seq'] : 'Save failed';