Skip to main content

API lấy trạng thái đơn hàng

API dùng để lấy trạng thái hiện tại của nhiều mã vận đơn

Mô tả​

Sau khi đơn hàng được gửi tới hệ thống của OMS. Khách hàng có thể kiểm tra trạng thái các đơn hàng dựa vào mã đơn hàng.

Request​

Đường dẫn​

POST /api/v1/orders/info

Headers​

Authorization: Bearer {JWT}
X-Client-Source: {PARTNER_CODE}
Content-Type: application/json

Code​

curl --location '{{url}}/api/v1/orders/info' \
--header 'Authorization: Bearer {{token}}' \
--header 'X-Client-Source: mwg' \
--header 'Content-Type: application/json' \
--data '{
    "order_ids": [
        "12345678"
    ]
}'

Tham số​

Tham sốBắt buộcMô tả
order_idsCóMã đơn hàng OMS

Phản hồi​

Kết quả trả về​

Hệ thống sẽ trả về kết quả dưới dạng JSON. Kết quả trả về được mô tả như sau:

Tham sốKiểu dữ liệuMô tả
partner_idStringMã đơn hàng của partner
oms_order_idStringMã đơn hàng thuộc hệ thống OMS
tracking_codeStringMã đơn hàng của đơn vị vận chuyển
pickup_timeStringThời gian lấy hàng , định dạng YY-MM-DD hh:mm:ss
delivery_timeStringThời gian giao hàng , định dạng YY-MM-DD hh:mm:ss
service_typeIntegerLoại hình thức giao, dịch vụ giao
provider_idStringMã đối tác vận chuyển
provider_nameStringTên đối tác vận chuyển
tracking_urlStringLink tracking đơn hàng
order_timeStringThời gian khách đặt
cod_amountIntegerSố tiền COD (VND). Nếu bằng 0 thì không thu tiền
pickupObjectThông tin điểm lấy hàng
deliveryObjectThông tin điểm giao hàng
itemsListThông tin sản phẩm
current_statusObjectTrạng thái hiện tại của vận đơn
historiesListLịch sử thay đổi trạng thái của đơn hàng

Field current_status​

Tham sốKiểu dữ liệuMô tả
statusStringMã Trạng thái chính của đơn hàng
labelStringÝ nghĩa Trạng thái chính của đơn hàng
action_timeStringThời gian thay đổi trạng thái

Field histories​

Tham sốKiểu dữ liệuMô tả
statusStringMã Trạng thái chính của đơn hàng
labelStringÝ nghĩa Trạng thái chính của đơn hàng
action_timeStringThời gian thay đổi trạng thái

Field pickup - Thông tin điểm lấy hàng​

Tham sốBắt buộcKiểu dữ liệuMô tả
nameyesstringTên người liên hệ lấy hàng hóa
addressyesstringĐịa chỉ chi tiết lấy hàng (VD nhà số 5, tổ 3, ngách 11, ngõ 45)
provinceyesstringTỉnh/Thành phố lấy hàng
wardyesstringPhường/xã lấy hàng (bắt buộc khi không có street)
telyesstringSố điện thoại nơi lấy hàng

Field delivery - Thông tin điểm giao hàng​

Tham sốBắt buộcKiểu dữ liệuMô tả
nameyesstringTên người nhận hàng
addressyesstringĐịa chỉ chi tiết người nhận hàng
provinceyesstringTỉnh/thành phố người nhận
wardyesstringPhường/xã người nhận (bắt buộc khi không có street)
hamletyesstringThôn/áp/xóm/tổ... người nhận. Nếu không có, dùng "Khác"
telyesstringSố điện thoại người nhận

Field items - Thông tin sản phẩm​

Tham sốBắt buộcKiểu dữ liệuMô tả
nameyesstringTên hàng hóa
weightyesfloatKhối lượng hàng hóa (kg)
quantityyesintegerSố lượng hàng hóa
codeyesstringMã sản phẩm

Thành công​

{
  "status": 200,
  "message": "",
  "timestamp": "2025-10-10T15:36:56.794Z",
  "data": [
    {
      "partner_id": "MDH12032001", //Mã lần giao - partner_id trong API GHTK
      "oms_order_id": "832974892", //Mã đơn OMS của GHTK
      "tracking_code": "VNPOST987654321", //Mã vận đơn
      "pickup_time": "2025-05-15T14:00:00Z", //Thời gian pick hàng
      "delivery_time": "2025-05-18T18:00:00Z", //Thời gian giao hàng
      "service_type": 2, //Loại hình thức giao, dịch vụ giao
      "provider_id": "VNPOST", //Mã đối tác vận chuyển
      "provider_name": "VNPost", //Tên đối tác vận chuyển
      "tracking_url": "https://vnpost.vn/tracking/VNPOST987654321", //Link tracking đơn hàng
      "order_time": "2025-05-15 10:00:00", // Thời gian khách đặt
      "cod_amount": 100000,
      "pickup": {
        "name": "Nguyễn Văn A",
        "address": "Số 97 ngõ 14 Mễ Trì Hạ",
        "province": "Hà Nội",
        "ward": "Phường Từ Liêm",
        "tel": "0901234567"
      },
      "delivery": {
        "name": "Trần Thị B",
        "address": "Trường Đại học Quốc gia Hà Nội",
        "province": "Hà Nội",
        "ward": "Phường Cầu Giấy",
        "hamlet": "Khác",
        "tel": "0912345678"
      },
      "items": [
        {
          "name": "Áo thun",
          "weight": 0.3,
          "quantity": 2,
          "code": "TSHIRT001"
        },
        {
          "name": "Quần jeans",
          "weight": 0.8,
          "quantity": 1,
          "code": "JEANS123"
        }
      ],
      "current_status": { //Trạng thái hiện tại của vận đơn
        "status": "in_transit",
        "label": "Đang vận chuyển",
        "action_time": "2025-05-16T09:00:00Z"
      },
      "histories": [
        {
          "status": "picked_up",
          "label": "Đã lấy hàng",
          "action_time": "2025-05-15T14:00:00Z"
        },
        {
          "status": "in_transit",
          "label": "Đang vận chuyển",
          "action_time": "2025-05-16T09:00:00Z"
        }
      ]
    },
    {
      "partner_id": "MDH12032002",
      "oms_order_id": "832974892", //Mã đơn OMS của GHTK
      "tracking_code": "GHTK123456789",
      "pickup_time": "2025-05-15T09:00:00Z",
      "delivery_time": "2025-05-19T20:00:00Z",
      "service_type": 1,
      "provider_id": "GHTK",
      "provider_name": "Giao Hàng Tiết Kiệm",
      "tracking_url": "https://ghtk.vn/tracking/GHTK123456789",
      "order_time": "2025-05-15 10:00:00", // Thời gian khách đặt
      "cod_amount": 100000,
      "pickup": {
        "name": "Nguyễn Văn A",
        "address": "Số 97 ngõ 14 Mễ Trì Hạ",
        "province": "Hà Nội",
        "ward": "Phường Từ Liêm",
        "tel": "0901234567"
      },
      "delivery": {
        "name": "Trần Thị B",
        "address": "Trường Đại học Quốc gia Hà Nội",
        "province": "Hà Nội",
        "ward": "Phường Cầu Giấy",
        "hamlet": "Khác",
        "tel": "0912345678"
      },
      "items": [
        {
          "name": "Áo thun",
          "weight": 0.3,
          "quantity": 2,
          "code": "TSHIRT001"
        },
        {
          "name": "Quần jeans",
          "weight": 0.8,
          "quantity": 1,
          "code": "JEANS123"
        }
      ],
      "current_status": {
        "status": "out_for_delivery",
        "label": "Đang giao hàng",
        "action_time": "2025-05-17T08:30:00Z"
      },
      "history": [
        {
          "status": "picked_up",
          "label": "Đã lấy hàng",
          "action_time": "2025-05-15T09:00:00Z"
        },
        {
          "status": "out_for_delivery",
          "label": "Đang giao hàng",
          "action_time": "2025-05-17T08:30:00Z"
        }
      ]
    }
  ]
}