Vào thẳng nội dung
account_circle Toanph date_range 24/08/2020

Kết nối VNPOST#

1. API gửi thông tin vận đơn#

Mục đích: Gửi thông tin vận đơn từ client sang hệ thống phần mềm của VNPOST

1. Request Header

  • URL: ***/api/BuuChinh/GuiVanDon
  • Method:: POST
  • Authorization: Bearer 'token'
  • Content-Type: application/json

2. Request body

{
    "CustomerCode":"Mã khách hàng do VNPost cung cấp", // Kiểu: String;
    "OrderNumber":"Mã hồ sơ (do đơn vị tiếp nhận hồ sơ cung cấp)", // Kiểu: String;
    "CODAmount":"Số tiền nhờ thu", // double
    "SenderProvince":"Mã tỉnh gửi (mã bưu điện cấp tỉnh do VNPost cung cấp)", // int
    "SenderDistrict":"Mã huyện gửi (mã bưu điện cấp huyện do VNPost cung cấp)", // int
    "SenderAddress":"Địa chỉ người / cơ quan gửi ", // String
    "SenderName":"Tên người / cơ quan gửi",  // String
    "SenderEmail":"Email người / cơ quan gửi", // String
    "SenderTel":"Số điện thoại người / cơ quan gửi", // String
    "SenderDesc":"Thành phần hồ sơ", // String
    "Description":"Ghi chú", // String
    "ReceiverName":"Tên người / cơ quan nhận", // String
    "ReceiverAddress":"Địa chỉ người / cơ quan nhận", // String
    "ReceiverTel":"Điện thoại người / cơ quan nhận", // String
    "ReceiverProvince":"Mã tỉnh nhận (mã bưu điện cấp tỉnh do VNPost cung cấp)", // int
    "ReceiverDistrict":"Mã huyện nhận (mã bưu điện cấp huyện do VNPost cung cấp)", // int
}

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

2. API Hủy thông tin vận đơn#

1. Request Header

  • URL: ***/api/BuuChinh/HuyVanDon
  • Method:: GET
  • Authorization: Bearer 'token'
  • Content-Type: application/json

2. Request Params

    CustomerCode: "Mã khách hàng do VNPost cung cấp",
    OrderNumber: "mã hồ sơ cần hủy"

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

3. API lấy thông tin vận chuyển#

1. Request Header

  • URL: ***/api/BuuChinh/LayThongTinVanChuyen
  • Method:: GET
  • Authorization: Bearer 'token'
  • Content-Type: application/json

2. Request Params

    pagesize: "số bản ghi cần lấy",
    lastId: "chuỗi ký tự (độ dài 24), thể hiện id bản ghi mới nhất đã lấy được từ lần gọi trước đó."

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

4. API Lấy giá cước vận chuyển#

1. Request Header

  • URL: ***/api/BuuChinh/GuiVanDon
  • Method:: POST
  • Authorization: Bearer 'token'
  • Content-Type: application/json

2. Request body

{
  "itemCode":"Thông tin về mã hồ sơ được quản lý trong hệ thống hành chính công. Trường này được sử dụng để trao đổi thông tin trạng thái hồ sơ giữa 2 hệ thống.",
  "itemType":"Loại giấy tờ, thủ tục hành chính công (cần thống nhất về danh mục này với hệ thống hành chính công) thông tin này nhằm VNPOST có thể hiểu rõ hơn về giấy tờ để có thể phục vụ tốt hơn.",
  "length":"Chiều dài của hàng gửi (được thiết kết nhằm phục vụ cho việc có thể gửi hàng hóa bưu kiện)",
  "height":"Chiều cao của hàng gửi (được thiết kết nhằm phục vụ cho việc có thể gửi hàng hóa bưu kiện)",
  "width":"Chiều rông của hàng gửi (được thiết kết nhằm phục vụ cho việc có thể gửi hàng hóa bưu kiện)",
  "weight":"Cân nặng của hàng gửi (được thiết kết nhằm phục vụ cho việc có thể gửi hàng hóa bưu kiện)",
  "sender": {
      "idNumber":"Dùng để lưu thông tin về định dang như số chứng minh thư, số hộ chiếu",
      "name":"Tên liên hệ",
      "provCode":"Mã tỉnh",
      "distCode":"Mã huyện",
      "commCode":"Mã xã",
      "address":"Lưu địa chỉ chi tiết",
      "phone":"Số điện thoại liên hệ",
      "mail":"Địa chỉ email"
  },
  "receiver": {
      "idNumber":"Dùng để lưu thông tin về định dang như số chứng minh thư, số hộ chiếu",
      "name":"Tên liên hệ",
      "provCode":"Mã tỉnh",
      "distCode":"Mã huyện",
      "commCode":"Mã xã",
      "address":"Lưu địa chỉ chi tiết",
      "phone":"Số điện thoại liên hệ",
      "mail":"Địa chỉ email"
  },
  "charge":"Trường này sẽ chứa số tiền mà cơ quan hành chính muốn nhờ VNPOST thu hộ tiền lệ phí dịch vụ công từ người dân. Trường này không xuất hiện hoặc có giá trị bằng 0 thì VNPOST sẽ không thu tiền. ",
  "mainSrv":"Mã dịch vụ sử dụng để gửi giấy tờ, kết quả. VNPOST sẽ thống nhất và đưa ra mã dịch vụ này.",
  "subSrv":"Mã dịch vụ giá trị gia tăng kèm theo",
  "fee":"Mức lệ phí mà VNPOST sẽ thu để cung cấp dịch vụ. ",
  "feeOnSender":"Trường này để chỉ ra rằng phí mà VNPOST sẽ thu tại người gửi.",
  "srvItemCode":"Mã bưu gửi, mã này là mã được quản lý trên hệ thống của VNPOST. Đối với một số khách hàng lơn, VNPOST có thể cấp trước giải số này để khách hàng có thể quản lý bằng chính mã bưu gửi của VNPOST.",
  "content":"Mô tả về nội dung của bưu gưi, ",
  "desc":"Mô tả chung về bưu gửi, các chỉ dẫn để giao hàng...",
  "isreturn":"Mô tả về chiều chuyển phát 0 chiều đi, 1 chiều về",
  "profileID":"Mô tả vè mã thủ tục hành chính trường hợp cước đặc biệt cho từng thủ tục hành chính",
  "location":"Mô tả về vị trí bưu gửi"
}

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

5. API lấy cước thu hộ lệ phí#

1. Request Header

  • URL: ***/api/BuuChinh/LayCuocThuHoLePhi
  • Method:: GET
  • Authorization: Bearer 'token'
  • Content-Type: application/json

2. Request Params

    ProfileFee: "Số tiền thu hộ lệ phí hành chính công"

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

6. API lấy thông tin bưu cục#

1. Request Header

  • URL: ***/api/BuuChinh/LayThongTinBuuCuc
  • Method:: GET
  • Authorization: Bearer 'token'
  • Content-Type: application/json

2. Request Params

    ProvinceCode: "Mã tỉnh VNPOST",
    DistrictCode: "Mã huyện VNPOST"

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}

7. API hiển thị giá cước niêm yết#

1. Request Header

  • URL: ***/api/BuuChinh/HienThiGiaCuoc
  • Method:: GET
  • Authorization: Bearer 'token'
  • Content-Type: application/json

2. Request Params

Không có param

3. Response body

{  
"code": "Mã trạng thái HTTP trả về", 
"status": "Mã trạng thái xử lý trả về", 
"correlationId": "Mã correlationId dành cho người lập trình trong quá trình kiểm tra kết nối",
"response": "Chuỗi Json kết quả dữ liệu được trả về từ hệ thống " 
}