คู่มือการใช้งาน API

ดึงข้อมูลบัญชีสมาชิกของคุณเป็น JSON ไปใช้ในระบบของคุณเอง

เริ่มต้นใช้งาน

เข้าสู่ระบบเว็บสมาชิก แล้วเปิดหน้า API Key
กดสร้างคีย์ แล้วคัดลอกเก็บไว้ทันที ระบบแสดงคีย์เต็มครั้งเดียว
ส่งคีย์ใน header X-Api-Key ทุกครั้งที่เรียก

ที่อยู่หลัก https://www.ptcargomember.com/legacy-export-api/api

ลองเรียกจริงโดยไม่ต้องเขียนโค้ดได้ที่หน้า ทดลองเรียก

การยืนยันตัวตน

คีย์หนึ่งคีย์ผูกกับรหัสสมาชิกที่สร้างคีย์นั้นตายตัว ข้อมูลที่ได้เป็นของรหัสนั้นเท่านั้น ไม่มีพารามิเตอร์ให้ระบุรหัสสมาชิก

ใช้ได้ฟรีเมื่อมีแต้มสะสมมากกว่า 1,000 แต้ม ตรวจทุกคำขอ แต้มไม่ถึงจะได้ 403 insufficient_points

ส่งคีย์แบบ	ตัวอย่าง
X-Api-Key	X-Api-Key: pk_xxxxxxxx
Authorization	Authorization: Bearer pk_xxxxxxxx

ไม่รับคีย์ทางที่อยู่ (?api_key=) เพื่อไม่ให้คีย์ค้างอยู่ในประวัติเบราว์เซอร์หรือ log คีย์รั่วให้เพิกถอนที่หน้า API Key ทันที

เรียกได้ 120 ครั้งต่อนาทีต่อรหัสสมาชิก เกินแล้วได้ 429 พร้อม header Retry-After

รูปแบบคำตอบ

สำเร็จได้ ok: true ข้อมูลอยู่ใน data หน้ารายการมี items กับ pagination

{
  "ok": true,
  "data": {
    "items": [ { "import_no": "PT139082", "status": { "code": "completed", "label": "เสร็จสมบูรณ์" }, ... } ],
    "pagination": { "page": 1, "per_page": 20, "total": 1777, "total_pages": 89 }
  },
  "request_id": "9f2c4a1b7d3e8f60"
}

รูปแบบค่า

ชนิด	รูปแบบ
วันที่	YYYY-MM-DD หรือ YYYY-MM-DD HH:MM:SS เวลาประเทศไทย ไม่มีค่าเป็น null
เงิน	ตัวเลขทศนิยม 2 ตำแหน่ง ชื่อลงท้าย _thb คือบาท _cny คือหยวน
สถานะ	{ "code": "...", "label": "..." } ใช้ code ในโปรแกรม label ไว้แสดงผล

ข้อผิดพลาด

{ "ok": false, "error": { "code": "not_found", "message": "ไม่พบบิลนำเข้านี้ในรหัสสมาชิกของคุณ" } }

HTTP	error.code	ความหมาย
400	invalid_date · invalid_status · invalid_bill_no · invalid_tracking_number · invalid_json	พารามิเตอร์หรือเนื้อคำขอไม่ถูกต้อง
401	unauthorized	ไม่มีคีย์ คีย์ผิด หรือถูกเพิกถอนแล้ว
402	insufficient_balance	เงินในกระเป๋าไม่พอ ดู shortfall_thb
403	forbidden_scope · insufficient_points	คีย์ไม่มีสิทธิ์ของเมนูนี้ หรือแต้มสะสมไม่ถึงเกณฑ์
404	not_found · route_not_found	ไม่พบข้อมูลในรหัสของคุณ หรือไม่มีที่อยู่นี้
409	price_changed · already_registered · duplicate_order_number · busy · request_in_progress	สถานะเปลี่ยนหรือมีรายการชนกัน
422	validation_error · parcel_not_available · idempotency_key_reused	ข้อมูลที่ส่งมาใช้ไม่ได้ ดู error.field
428	idempotency_key_required	คำขอ POST ต้องมี Idempotency-Key
429	rate_limited	เรียกถี่เกินไป รอตาม Retry-After
500 / 503	internal_error · service_unavailable	ระบบขัดข้อง แจ้งเจ้าหน้าที่พร้อม request_id

ตัวอย่างโค้ด

curl -H "X-Api-Key: pk_xxxxxxxx" \
  "https://www.ptcargomember.com/legacy-export-api/api/v1/imports?status=awaiting_payment&per_page=50"

const res = await fetch('https://www.ptcargomember.com/legacy-export-api/api/v1/parcel-status/JT3176108996635', {
  headers: { 'X-Api-Key': process.env.PTCARGO_API_KEY }
});
const body = await res.json();
if (!body.ok) throw new Error(body.error.code);
console.log(body.data.parcels[0].stage.label);

$ch = curl_init('https://www.ptcargomember.com/legacy-export-api/api/v1/finance-history?from=2026-09-01');
curl_setopt_array($ch, array(
    CURLOPT_HTTPHEADER     => array('X-Api-Key: ' . getenv('PTCARGO_API_KEY')),
    CURLOPT_RETURNTRANSFER => true,
));
$body = json_decode(curl_exec($ch), true);
echo $body['data']['wallet_balance_thb'];

การสั่งทำรายการ

คำขอ POST ส่งเนื้อเป็น JSON และต้องใช้ API Key ที่เปิดสิทธิ์ของเมนูนั้นไว้ตอนสร้างคีย์

header	ความหมาย
Content-Type: application/json	เนื้อคำขอเป็น JSON object
Idempotency-Key: <ค่าไม่ซ้ำ>	บังคับ ใช้ค่าใหม่ต่อหนึ่งรายการ เช่นเลขออเดอร์ในระบบคุณ ส่งซ้ำด้วยค่าเดิมจะได้คำตอบเดิมโดยไม่ทำรายการซ้ำ (header Idempotent-Replayed: true)

เงินในกระเป๋า

แลกเงินหยวน เติมเงิน Alipay และฝากจ่าย หักเงินจากกระเป๋าทันทีตอนสร้าง ดูเรทและยอดคงเหลือก่อนได้ที่ GET /v1/rates ส่ง expected_total_thb มาด้วยเพื่อกันเรทเปลี่ยนระหว่างทาง

ใบสั่งซื้อและบิลจัดส่งยังไม่หักเงินตอนสร้าง ยอดที่ต้องชำระจะขึ้นใน amounts.outstanding_thb หลังเจ้าหน้าที่สรุปราคา

curl -X POST "https://www.ptcargomember.com/legacy-export-api/api/v1/alipay-topups"   -H "X-Api-Key: pk_xxxxxxxx"   -H "Idempotency-Key: shop-20260915-0001"   -H "Content-Type: application/json"   -d '{"wallet_account_id": 1234, "amount_cny": 500, "expected_total_thb": 2703.75}'

Webhook

ลงทะเบียนปลายทางที่หน้า Webhook ระบบส่ง POST JSON ไปเมื่อสร้างรายการหรือสถานะเปลี่ยน ตรวจการเปลี่ยนแปลงทุกนาที

{
  "id": "evt_4f1a9c0b2d7e8a61c3b5",
  "type": "delivery.status_changed",
  "created_at": "2026-09-15 18:02:11",
  "data": {
    "resource_no": "RE158560",
    "previous": { "status": { "code": "awaiting_payment", "label": "รอชำระเงิน" } },
    "object": { "delivery_no": "RE158560", "status": { "code": "shipped", "label": "จัดส่งแล้ว" }, ... }
  }
}

ชนิดเหตุการณ์

type	เกิดเมื่อ
purchase_order.created	สร้างใบสั่งซื้อ
purchase_order.status_changed	ใบสั่งซื้อเปลี่ยนสถานะ
import.created	มีบิลนำเข้าใหม่
import.status_changed	บิลนำเข้าเปลี่ยนสถานะ
yuan_exchange.created	สร้างรายการแลกเงินหยวน
yuan_exchange.status_changed	แลกเงินหยวนเปลี่ยนสถานะ
alipay_topup.created	สร้างรายการเติม Alipay
alipay_topup.status_changed	เติม Alipay เปลี่ยนสถานะ
pay_on_behalf.created	สร้างบิลฝากจ่าย
pay_on_behalf.status_changed	ฝากจ่ายเปลี่ยนสถานะ
delivery.created	สร้างบิลจัดส่ง/มารับ
delivery.status_changed	จัดส่ง/มารับเปลี่ยนสถานะ
delivery.deleted	บิลจัดส่งถูกยกเลิกและลบ
parcel.arrived_china_warehouse	พัสดุเข้าโกดังจีน
parcel.arrived_thailand	พัสดุถึงโกดังไทย
my_tracking_number.created	แจ้งเลขแท็คกิ้ง

ตรวจลายเซ็น

ทุกคำขอมี header X-PTCargo-Signature: t=<เวลา unix>,v1=<ลายเซ็น> ลายเซ็นคือ HMAC-SHA256 ของ t + "." + เนื้อคำขอดิบ ด้วยกุญแจที่ได้ตอนลงทะเบียน ปฏิเสธคำขอที่ลายเซ็นไม่ตรงหรือ t เก่ากว่า 5 นาที

$raw = file_get_contents('php://input');
parse_str(str_replace(',', '&', $_SERVER['HTTP_X_PTCARGO_SIGNATURE']), $sig);
$expect = hash_hmac('sha256', $sig['t'] . '.' . $raw, getenv('PTCARGO_WEBHOOK_SECRET'));
if (!hash_equals($expect, $sig['v1']) || abs(time() - (int) $sig['t']) > 300) {
    http_response_code(400); exit;
}
$event = json_decode($raw, true);   // ใช้ $event['id'] กันประมวลผลซ้ำ
http_response_code(200);

ตอบ 2xx ภายใน 10 วินาทีถือว่าได้รับ ไม่ตอบหรือตอบอย่างอื่นระบบส่งซ้ำอีกสูงสุด 8 ครั้ง (1 นาที ถึง 1 วัน) เหตุการณ์เดียวกันอาจมาถึงมากกว่าหนึ่งครั้ง ให้ใช้ id กันซ้ำ

สร้างใบสั่งซื้อ

POST /v1/purchase-orders

สร้างใบสั่งซื้อ สถานะเริ่มต้นรอใบเสนอราคา ยังไม่หักเงิน เจ้าหน้าที่จะสรุปราคาแล้วแจ้งชำระ

สิทธิ์คีย์ที่ต้องมี order.create · ตอบ 201 พร้อมรายการที่สร้าง

พารามิเตอร์	ส่งทาง	ความหมาย
items	เนื้อ JSON	รายการสินค้า 1-50 รายการ (บังคับ)
items[].shop	เนื้อ JSON	ชื่อร้าน (บังคับ)
items[].product_url	เนื้อ JSON	ลิงก์สินค้า http/https (บังคับ)
items[].unit_price_cny	เนื้อ JSON	ราคาต่อชิ้น หยวน (บังคับ)
items[].quantity	เนื้อ JSON	จำนวน (บังคับ)
items[].image_url	เนื้อ JSON	ลิงก์รูป
items[].size / color / other_option / note	เนื้อ JSON	ตัวเลือกและหมายเหตุของสินค้า
shipping_method	เนื้อ JSON	truck_express (ค่าเริ่มต้น) · truck_ek · sea
quality_check	เนื้อ JSON	true = ตรวจสินค้า (QC)
wooden_crate	เนื้อ JSON	true = ตีลังไม้
price_increase_limit_cny	เนื้อ JSON	ยอมให้ราคาต่อชิ้นเพิ่มได้ไม่เกินกี่หยวน
coupon_code	เนื้อ JSON	โค้ดส่วนลด
note	เนื้อ JSON	หมายเหตุถึงเจ้าหน้าที่

แจ้งแท็คกิ้งของฉัน

POST /v1/my-tracking-numbers

แจ้งเลขแท็คกิ้งจีนของพัสดุที่กำลังส่งเข้าโกดัง

สิทธิ์คีย์ที่ต้องมี track.create · ตอบ 201 พร้อมรายการที่สร้าง

พารามิเตอร์	ส่งทาง	ความหมาย
tracking_number	เนื้อ JSON	เลขแท็คกิ้ง ตัวอักษรหรือตัวเลข 4-30 ตัว (บังคับ)
note	เนื้อ JSON	หมายเหตุ เช่น ชื่อสินค้า

แลกเงินหยวน

POST /v1/yuan-exchanges

แลกเงินหยวนโอนเข้าบัญชีธนาคารจีน หักเงินจากกระเป๋าทันที

สิทธิ์คีย์ที่ต้องมี exchange.create · ตอบ 201 พร้อมรายการที่สร้าง

พารามิเตอร์	ส่งทาง	ความหมาย
bank_account_id	เนื้อ JSON	จาก GET /v1/yuan-exchanges/bank-accounts (บังคับ)
amount_cny	เนื้อ JSON	จำนวนหยวน ตั้งแต่ 1 (บังคับ)
coupon_code	เนื้อ JSON	โค้ดส่วนลด ใช้แล้วไม่คิดค่าบริการ
expected_total_thb	เนื้อ JSON	ยอดบาทที่คาดไว้ ถ้าเรทเปลี่ยนจะได้ 409 price_changed แทนการหักเงิน

เติมเงิน Alipay

POST /v1/alipay-topups

เติมเงินเข้าบัญชี Alipay / WeChat หักเงินจากกระเป๋าทันที

สิทธิ์คีย์ที่ต้องมี alipay.create · ตอบ 201 พร้อมรายการที่สร้าง

พารามิเตอร์	ส่งทาง	ความหมาย
wallet_account_id	เนื้อ JSON	จาก GET /v1/alipay-topups/wallet-accounts (บังคับ)
amount_cny	เนื้อ JSON	จำนวนหยวน ตั้งแต่ 1 (บังคับ)
coupon_code	เนื้อ JSON	โค้ดส่วนลด ใช้แล้วไม่คิดค่าบริการ
expected_total_thb	เนื้อ JSON	ยอดบาทที่คาดไว้

ฝากจ่าย

POST /v1/pay-on-behalf

ฝากจ่ายออเดอร์ร้านจีน หักเงินจากกระเป๋าทันที ค่าบริการคิดครั้งเดียวต่อบิล

สิทธิ์คีย์ที่ต้องมี helppay.create · ตอบ 201 พร้อมรายการที่สร้าง

พารามิเตอร์	ส่งทาง	ความหมาย
shop_account_id	เนื้อ JSON	จาก GET /v1/pay-on-behalf/shop-accounts (บังคับ)
orders	เนื้อ JSON	ออเดอร์ 1-50 รายการ (บังคับ)
orders[].website	เนื้อ JSON	taobao · tmall · 1688
orders[].order_number	เนื้อ JSON	เลขออเดอร์ ตัวเลข 6-24 หลัก
orders[].amount_cny	เนื้อ JSON	ยอดที่ต้องจ่ายร้าน หยวน
orders[].note	เนื้อ JSON	หมายเหตุ
note	เนื้อ JSON	หมายเหตุของบิล
expected_total_thb	เนื้อ JSON	ยอดบาทที่คาดไว้

จัดส่ง/มารับ

POST /v1/deliveries

สร้างบิลจัดส่งหรือมารับเอง ยังไม่หักเงิน จัดส่งจะสรุปค่าส่งหลังชั่งของ

สิทธิ์คีย์ที่ต้องมี delivery.create · ตอบ 201 พร้อมรายการที่สร้าง

พารามิเตอร์	ส่งทาง	ความหมาย
method	เนื้อ JSON	delivery หรือ pickup (บังคับ)
parcel_ids	เนื้อ JSON	จาก GET /v1/deliveries/ready-parcels (บังคับ)
carrier	เนื้อ JSON	ชื่อบริษัทขนส่งจาก GET /v1/deliveries/carriers (บังคับเมื่อ delivery)
recipient_address_id	เนื้อ JSON	จาก GET /v1/deliveries/recipient-addresses (บังคับเมื่อ delivery)
sender_address_id	เนื้อ JSON	จาก GET /v1/deliveries/sender-addresses ไม่ส่งคือใช้ผู้ส่งของบริษัท
note	เนื้อ JSON	หมายเหตุถึงเจ้าหน้าที่

ประวัติสั่งซื้อ

GET /v1/purchase-orders

รายการใบสั่งซื้อทั้งหมด ใหม่สุดก่อน

พารามิเตอร์	ส่งทาง	ความหมาย
page	ท้ายที่อยู่	หน้าที่ต้องการ เริ่มที่ 1
per_page	ท้ายที่อยู่	จำนวนต่อหน้า 1-100 (ค่าเริ่มต้น 20)
from	ท้ายที่อยู่	วันที่เริ่ม YYYY-MM-DD
to	ท้ายที่อยู่	วันที่สิ้นสุด YYYY-MM-DD
status	ท้ายที่อยู่	กรองตามรหัสสถานะ (ดูตารางสถานะ)

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
order_no	เลขใบสั่งซื้อ เช่น FC135790
order_date	วันที่สร้างใบสั่งซื้อ
status	สถานะ {code, label}
shipping_method	วิธีขนส่งจีน-ไทย {code, label}
options	บริการเสริม ตรวจสินค้า ประกัน ตีลังไม้
yuan_rate	เรทหยวนของบิล
amounts.goods_thb	ค่าสินค้า ค่าส่งในจีน ค่าบริการ รวมเป็นบาท
amounts.import_thb	ค่านำเข้า (บาท)
amounts.total_thb	ยอดรวมของบิล (บาท) คิดแบบเดียวกับตอนกดชำระบนเว็บ
amounts.paid_thb	ยอดที่ชำระแล้ว (บาท)
amounts.outstanding_thb	ยอดค้างชำระ (บาท) ติดลบคือจ่ายเกิน รอคืน

GET /v1/purchase-orders/{order_no}

รายละเอียดใบสั่งซื้อ พร้อมร้าน สินค้า และพัสดุ

พารามิเตอร์	ส่งทาง	ความหมาย
order_no	ในที่อยู่	เลขใบสั่งซื้อ

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
shops	ร้านในบิล เลขออเดอร์จีน เลขแท็คกิ้งในจีน ค่าส่งในจีน
products	สินค้า ลิงก์ ขนาด สี ราคาต่อชิ้น (หยวน) จำนวน
parcels	พัสดุของบิล น้ำหนัก ขนาด วันถึงโกดังจีน/ไทย ค่านำเข้า

ประวัตินำเข้า

GET /v1/imports

รายการบิลนำเข้า (บิล PT) ใหม่สุดก่อน

พารามิเตอร์	ส่งทาง	ความหมาย
page	ท้ายที่อยู่	หน้าที่ต้องการ เริ่มที่ 1
per_page	ท้ายที่อยู่	จำนวนต่อหน้า 1-100 (ค่าเริ่มต้น 20)
from	ท้ายที่อยู่	วันที่เริ่ม YYYY-MM-DD
to	ท้ายที่อยู่	วันที่สิ้นสุด YYYY-MM-DD
status	ท้ายที่อยู่	กรองตามรหัสสถานะ (ดูตารางสถานะ)

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
import_no	เลขบิลนำเข้า เช่น PT139082
import_date	วันที่ของบิล
status	สถานะ {code, label}
parcel_count	จำนวนพัสดุในบิล
parcels_arrived_thailand	จำนวนพัสดุที่ถึงโกดังไทยแล้ว
amounts.total_thb	ยอดรวมของบิล (บาท) คิดแบบเดียวกับตอนกดชำระบนเว็บ
amounts.paid_thb	ยอดที่ชำระแล้ว (บาท)
amounts.outstanding_thb	ยอดค้างชำระ (บาท) ติดลบคือจ่ายเกิน รอคืน

GET /v1/imports/{import_no}

รายละเอียดบิลนำเข้า พร้อมพัสดุทุกกล่อง

พารามิเตอร์	ส่งทาง	ความหมาย
import_no	ในที่อยู่	เลขบิลนำเข้า

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
parcels.tracking_numbers	เลขแท็คกิ้งจีนของกล่อง
parcels.arrived_china_at	วันที่ถึงโกดังจีน
parcels.arrived_thailand_at	วันที่ถึงโกดังไทย ว่างคือยังไม่ถึง
parcels.charge_basis	คิดค่านำเข้าตาม weight / volume / piece / container / free
parcels.import_cost_thb	ค่านำเข้าของกล่อง (บาท)

ประวัติแลกเงินหยวน

GET /v1/yuan-exchanges

รายการแลกเงินหยวน โอนเข้าบัญชีธนาคารจีน

พารามิเตอร์	ส่งทาง	ความหมาย
page	ท้ายที่อยู่	หน้าที่ต้องการ เริ่มที่ 1
per_page	ท้ายที่อยู่	จำนวนต่อหน้า 1-100 (ค่าเริ่มต้น 20)
from	ท้ายที่อยู่	วันที่เริ่ม YYYY-MM-DD
to	ท้ายที่อยู่	วันที่สิ้นสุด YYYY-MM-DD
status	ท้ายที่อยู่	กรองตามรหัสสถานะ (ดูตารางสถานะ)

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
exchange_no	เลขรายการ เช่น T00779
requested_at	วันเวลาที่แจ้ง
completed_at	วันเวลาที่โอนสำเร็จ
china_bank_account	บัญชีปลายทางในจีน
amounts.requested_cny	ยอดที่ขอโอน (หยวน)
amounts.transferred_cny	ยอดที่โอนจริง (หยวน)
amounts.fee_cny	ค่าบริการ (หยวน)
amounts.total_thb	ยอดรวมของบิล (บาท) คิดแบบเดียวกับตอนกดชำระบนเว็บ
amounts.paid_thb	ยอดที่ชำระแล้ว (บาท)
amounts.outstanding_thb	ยอดค้างชำระ (บาท) ติดลบคือจ่ายเกิน รอคืน

GET /v1/yuan-exchanges/bank-accounts

บัญชีธนาคารจีนที่บันทึกไว้ ใช้ bank_account_id ตอนแลกเงินหยวน

GET /v1/yuan-exchanges/{exchange_no}

รายละเอียดรายการแลกเงินหยวน

พารามิเตอร์	ส่งทาง	ความหมาย
exchange_no	ในที่อยู่	เลขรายการ

ประวัติเติม Alipay

GET /v1/alipay-topups

รายการเติมเงิน Alipay / WeChat

พารามิเตอร์	ส่งทาง	ความหมาย
page	ท้ายที่อยู่	หน้าที่ต้องการ เริ่มที่ 1
per_page	ท้ายที่อยู่	จำนวนต่อหน้า 1-100 (ค่าเริ่มต้น 20)
from	ท้ายที่อยู่	วันที่เริ่ม YYYY-MM-DD
to	ท้ายที่อยู่	วันที่สิ้นสุด YYYY-MM-DD
status	ท้ายที่อยู่	กรองตามรหัสสถานะ (ดูตารางสถานะ)

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
topup_no	เลขรายการ เช่น R03994
wallet	บัญชีที่เติม {type: alipay\|wechat, username}
amounts.requested_cny	ยอดที่ขอเติม (หยวน)
amounts.topped_up_cny	ยอดที่เติมจริง (หยวน)
amounts.total_thb	ยอดรวมของบิล (บาท) คิดแบบเดียวกับตอนกดชำระบนเว็บ
amounts.paid_thb	ยอดที่ชำระแล้ว (บาท)
amounts.outstanding_thb	ยอดค้างชำระ (บาท) ติดลบคือจ่ายเกิน รอคืน

GET /v1/alipay-topups/wallet-accounts

บัญชี Alipay / WeChat ที่บันทึกไว้ ใช้ wallet_account_id ตอนเติมเงิน

GET /v1/alipay-topups/{topup_no}

รายละเอียดรายการเติม Alipay

พารามิเตอร์	ส่งทาง	ความหมาย
topup_no	ในที่อยู่	เลขรายการ

ประวัติฝากจ่าย

GET /v1/pay-on-behalf

รายการฝากจ่ายร้านจีน (Taobao / Tmall / 1688)

พารามิเตอร์	ส่งทาง	ความหมาย
page	ท้ายที่อยู่	หน้าที่ต้องการ เริ่มที่ 1
per_page	ท้ายที่อยู่	จำนวนต่อหน้า 1-100 (ค่าเริ่มต้น 20)
from	ท้ายที่อยู่	วันที่เริ่ม YYYY-MM-DD
to	ท้ายที่อยู่	วันที่สิ้นสุด YYYY-MM-DD
status	ท้ายที่อยู่	กรองตามรหัสสถานะ (ดูตารางสถานะ)

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
bill_no	เลขบิลฝากจ่าย เช่น HP00492
platform_username	บัญชีร้านที่ใช้กดจ่าย
amounts.requested_cny	ยอดที่ขอให้จ่าย (หยวน)
amounts.paid_to_seller_cny	ยอดที่จ่ายร้านจริง (หยวน)
amounts.refund_thb	ยอดคืนที่อนุมัติแล้ว (บาท)
amounts.total_thb	ยอดรวมของบิล (บาท) คิดแบบเดียวกับตอนกดชำระบนเว็บ
amounts.paid_thb	ยอดที่ชำระแล้ว (บาท)
amounts.outstanding_thb	ยอดค้างชำระ (บาท) ติดลบคือจ่ายเกิน รอคืน

GET /v1/pay-on-behalf/shop-accounts

บัญชีร้าน Taobao / Tmall / 1688 ที่บันทึกไว้ ใช้ shop_account_id ตอนฝากจ่าย

GET /v1/pay-on-behalf/{bill_no}

รายละเอียดบิลฝากจ่าย พร้อมออเดอร์และรายการคืนเงิน

พารามิเตอร์	ส่งทาง	ความหมาย
bill_no	ในที่อยู่	เลขบิลฝากจ่าย

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
orders	ออเดอร์ที่ฝากจ่าย
refunds	คำขอคืนเงินของบิล

ประวัติจัดส่ง/มารับ

GET /v1/deliveries

รายการจัดส่งและมารับเอง

พารามิเตอร์	ส่งทาง	ความหมาย
page	ท้ายที่อยู่	หน้าที่ต้องการ เริ่มที่ 1
per_page	ท้ายที่อยู่	จำนวนต่อหน้า 1-100 (ค่าเริ่มต้น 20)
from	ท้ายที่อยู่	วันที่เริ่ม YYYY-MM-DD
to	ท้ายที่อยู่	วันที่สิ้นสุด YYYY-MM-DD
status	ท้ายที่อยู่	กรองตามรหัสสถานะ (ดูตารางสถานะ)
method	ท้ายที่อยู่	delivery = จัดส่ง pickup = มารับเอง

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
delivery_no	เลขบิลจัดส่ง เช่น RE156040
method	delivery หรือ pickup
carrier	บริษัทขนส่ง ว่างเมื่อมารับเอง
carrier_tracking_numbers	เลขพัสดุของบริษัทขนส่งในไทย
recipient	ผู้รับ ชื่อ โทร ที่อยู่
sender	ผู้ส่ง ว่างคือใช้ผู้ส่งตั้งต้นของบริษัท
amounts.total_thb	ยอดรวมของบิล (บาท) คิดแบบเดียวกับตอนกดชำระบนเว็บ
amounts.paid_thb	ยอดที่ชำระแล้ว (บาท)
amounts.outstanding_thb	ยอดค้างชำระ (บาท) ติดลบคือจ่ายเกิน รอคืน

GET /v1/deliveries/ready-parcels

พัสดุที่ยังไม่อยู่ในบิลจัดส่ง ใช้ parcel_id ตอนสร้างบิลจัดส่ง/มารับ

GET /v1/deliveries/carriers

บริษัทขนส่งที่เลือกได้ และค่าบริการต่อบิล

GET /v1/deliveries/recipient-addresses

ที่อยู่ผู้รับที่บันทึกไว้

GET /v1/deliveries/sender-addresses

ที่อยู่ผู้ส่งที่บันทึกไว้

GET /v1/deliveries/{delivery_no}

รายละเอียดบิลจัดส่ง พร้อมพัสดุในบิล

พารามิเตอร์	ส่งทาง	ความหมาย
delivery_no	ในที่อยู่	เลขบิลจัดส่ง

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
parcels	พัสดุที่อยู่ในบิลนี้

ประวัติการเงิน

GET /v1/finance-history

รายการเงินเข้าออกของบัญชี และยอดเงินคงเหลือ

พารามิเตอร์	ส่งทาง	ความหมาย
page	ท้ายที่อยู่	หน้าที่ต้องการ เริ่มที่ 1
per_page	ท้ายที่อยู่	จำนวนต่อหน้า 1-100 (ค่าเริ่มต้น 20)
from	ท้ายที่อยู่	วันที่เริ่ม YYYY-MM-DD
to	ท้ายที่อยู่	วันที่สิ้นสุด YYYY-MM-DD
status	ท้ายที่อยู่	กรองตามรหัสสถานะ (ดูตารางสถานะ)
reference_no	ท้ายที่อยู่	กรองตามเลขบิลที่เกี่ยวข้อง

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
items.transaction_at	วันเวลาของรายการ
items.type	ชนิดรายการ {code, label}
items.reference_no	เลขบิลหรือเลขรายการที่เกี่ยวข้อง
items.direction	in = เงินเข้า out = เงินออก
items.amount_thb	จำนวนเงิน (บาท) เป็นบวกเสมอ
wallet_balance_thb	ยอดเงินคงเหลือในบัญชี (บาท)

GET /v1/rates

เรทหยวน ค่าบริการปัจจุบัน และยอดเงินคงเหลือ ใช้คิดยอดก่อนสั่งทำรายการ

ประวัติเลขแท็คกิ้งของฉัน

GET /v1/my-tracking-numbers

เลขแท็คกิ้งที่แจ้งไว้

พารามิเตอร์	ส่งทาง	ความหมาย
page	ท้ายที่อยู่	หน้าที่ต้องการ เริ่มที่ 1
per_page	ท้ายที่อยู่	จำนวนต่อหน้า 1-100 (ค่าเริ่มต้น 20)
from	ท้ายที่อยู่	วันที่เริ่ม YYYY-MM-DD
to	ท้ายที่อยู่	วันที่สิ้นสุด YYYY-MM-DD
status	ท้ายที่อยู่	กรองตามรหัสสถานะ (ดูตารางสถานะ)

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
items.tracking_number	เลขแท็คกิ้ง
items.note	หมายเหตุที่แจ้งไว้
items.registered_at	วันเวลาที่แจ้ง
items.status	สถานะ {code, label}

เช็คสถานะพัสดุ

GET /v1/parcel-status/{tracking_number}

เช็คสถานะพัสดุด้วยเลขแท็คกิ้ง ค้นเฉพาะพัสดุของรหัสคุณ

พารามิเตอร์	ส่งทาง	ความหมาย
tracking_number	ในที่อยู่	เลขแท็คกิ้ง 4-40 ตัว

ช่องสำคัญในผลลัพธ์

ช่อง	ความหมาย
parcels.stage	ขั้นตอนปัจจุบัน {code, label}
parcels.bill_no	เลขบิลที่พัสดุอยู่
parcels.delivery	ข้อมูลจัดส่งในไทย ว่างคือยังไม่สร้างบิลจัดส่ง

รหัสสถานะ

ใช้กรองด้วย ?status= ได้ในเมนูที่มีตารางนั้น ค่าที่ไม่รู้จักจะได้ code = other พร้อม label เดิม

ใบสั่งซื้อ

code	label
selecting	เลือกสินค้า
awaiting_quote	รอใบเสนอราคา
awaiting_payment	รอชำระค่าสินค้า
awaiting_purchase	รอกดสั่งซื้อ
awaiting_supplier_payment	รอจ่ายร้านจีน
pre_order	พรีออเดอร์
purchased	สั่งซื้อแล้ว
awaiting_import_payment	รอชำระค่านำเข้า
choosing_delivery	เลือกการจัดส่ง
awaiting_delivery_quote	รอสรุปค่าจัดส่ง
awaiting_delivery_payment	รอชำระค่าจัดส่ง
awaiting_shipment	รอจัดส่ง
ready_for_pickup	มารับได้
shipped	จัดส่งแล้ว
out_of_stock	สินค้าหมด
full_container	เหมาตู้
cancelled	ยกเลิก

บิลนำเข้า

code	label
choosing_delivery	เลือกการจัดส่ง
awaiting_payment	รอชำระค่านำเข้า
completed	เสร็จสมบูรณ์
cancelled	ยกเลิก

แลกเงินหยวน · เติม Alipay · ฝากจ่าย

code	label
pending	รอยืนยัน
processing	รอกดจ่าย
cancel_requested	แจ้งยกเลิก
completed	ยืนยัน
rejected	ไม่ยืนยัน
cancelled	ยกเลิก

จัดส่ง / มารับ

code	label
awaiting_quote	รอสรุปค่าจัดส่ง
awaiting_payment	รอชำระเงิน
awaiting_shipment	รอจัดส่ง
shipped	จัดส่งแล้ว
awaiting_pickup_notice	รอแจ้งมารับ
ready_for_pickup	รอมารับ
picked_up	มารับแล้ว
returned	ส่งกลับ
cancel_requested	แจ้งยกเลิก
cancelled	ไม่ยืนยัน

รายการการเงิน

code	label
pending	รอยืนยัน
completed	ยืนยัน
rejected	ไม่ยืนยัน
cancelled	ยกเลิก

ชนิดรายการการเงิน

code	label
payment	ชำระเงิน
top_up	เติมเงิน PTPAY
refund	โอนเงินคืน
withdrawal	ถอนเงิน PTPAY
commission	ส่วนแบ่ง
pay_on_behalf_refund	โอนคืนฝากจ่าย
account_transfer	ย้ายเงิน
lucky_draw	วัดดวง

เลขแท็คกิ้งของฉัน

code	label
waiting	รอดำเนินการ
received	ได้รับแล้ว
not_yours	ไม่ใช่ของคุณ

ขั้นตอนพัสดุ (เช็คสถานะพัสดุ)

code	label
registered	แจ้งเลขแท็คกิ้งแล้ว รอเข้าโกดังจีน
arrived_china_warehouse	ถึงโกดังจีนแล้ว
arrived_thailand	ถึงโกดังไทยแล้ว
awaiting_delivery	สร้างบิลจัดส่งแล้ว รอส่ง
ready_for_pickup	รอมารับ
shipped	จัดส่งแล้ว
picked_up	มารับแล้ว