Rate API

Rate API dùng để lấy biểu phí vận chuyển của tất cả các đơn vị vận chuyển có cung ứng dịch vụ trên tuyến lấy/giao hàng.

Bắt đầu lấy bảng phí vận chuyển:

POST http://sandbox.goship.io/api/v2/rates

Request body:

{
  "shipment": {
    "address_from": {
      "district": "100100",
      "city": "100000"
    },
    "address_from": {
      "district": "100100",
      "city": "100000"
    },
    "parcel": {
      "cod": 500000,
      "amount": 500000,
      "width": 10,
      "height": 10,
      "length": 10,
      "weight": 750
    }
  }
}

Trong đó:

address_from: Thông tin địa chỉ người gửi
address_to: Thông tin địa chỉ người nhận
district: Mã quận/huyện người gửi, lấy trong API District
city: Mã tỉnh/thành phố người gửi, lấy trong API City
parcel: Thông tin gói hàng
cod: Số tiền cần thu hộ, thông tin này sẽ ảnh hưởng tới cước phí trong trường hợp hãng vận chuyển áp dụng quy định tính phí thu hộ.
amount: Giá trị thực của kiện hàng. Giá trị này liên quan đến tiền khai giá và phí khai giá.
width: Thông tin chiều rộng gói hàng, tính theo đơn vị cm
height: Thông tin chiều cao gói hàng, tính theo đơn vị cm
length: Thông tin chiều dài gói hàng, tính theo đơn vị cm
weight: Thông tin về cân nặng gói hàng, tính theo đơn vị gam

*Ghi chú: Hệ thống sẽ áp dụng mức cân nặng quy đổi trong trường hợp cân nặng quy đổi lớn hơn cân nặng khai báo.

Cân nặng quy đổi = (Dài x Rộng x Cao) / Trọng số cân quy đổi

Với Trọng số cân quy đổi phụ thuộc vào quy định từng hãng vận chuyển, thông thường giá trị của nó là 6000.

Về vấn đề khai giá, mỗi đơn vị vận chuyển sẽ có mức tính phí khai giá khác nhau nhưng hiện tại phổ biến là miễn phí nếu giá trị khai giá dưới 1.000.000đ và 0.5% nếu trên 1.000.000đ. Giá trị khai giá là cơ sở để tính bồi thường nếu kiện hàng xảy ra sự cố (hư hỏng, thất lạc...). Kinh nghiệm tối ưu phí khai giá là đơn hàng dưới 1.000.000đ sẽ luôn mặc định khai giá, đơn hàng trên 1 triệu sẽ tùy vào đặc tính (category) của hàng hóa mà cân nhắc có nên khai giá full hay khai giá 1 phần.

Response data:

Success

{
  "code": 200,
  "status": "success",
  "data": [
    {
      "id": "OF8xXzc0OQ==",
      "carrier_name": "Vietnam Post",
      "carrier_logo": "http:\/\/sandbox.goship.io\/storage\/images\/carriers\/vnpost_c.png",
      "service": "Tiết kiệm",
      "expected": "Dự kiến giao trong 6 ngày", 
      "cod_fee": 0,
      "total_fee": 13000,
      "total_amount": 13000,
      "expected_txt": ""
    },
    {
      "id": "MV83XzU5OA==",
      "carrier_name": "Giao Hàng Tiết Kiệm",
      "carrier_logo": "http:\/\/sandbox.goship.io\/storage\/images\/carriers\/ghtk_c.png",
      "service": "Nhanh",
      "expected": "Dự kiến giao trong 1 ngày",
      "cod_fee": 0,
      "total_fee": 18000,
      "total_amount": 18000
    }
  ]
}

Trong đó:

id: ID bảng phí, sử dụng để tạo vận đơn
carrier_name: Tên hãng vận chuyển
carrier_logo: Ảnh logo hãng vận chuyển
service: Gói dịch vụ Nhanh/Chậm/Tiết kiệm
expected: Thời gian dự kiến giao hàng
cod_fee: Phí COD
total_fee: Phí vận chuyển tạm tính
total_amount: Tổng phí vận chuyển

Error

{
  "code": 422,
  "status": "error",
  "data": {
    "errors": {
      "shipment.address_from.district": [
        "Thiếu thông tin quận\/huyện người gửi"
      ],
      "shipment.address_from.city": [
        "Thiếu thông tin tỉnh\/TP người gửi"
      ],
      "shipment.address_to.district": [
        "Thiếu thông tin quận\/huyện người nhận"
      ],
      "shipment.address_to.city": [
        "Thiếu thông tin tỉnh\/TP người nhận"
      ],
      "shipment.parcel.weight": [
        "Thiếu thông tin cân nặng"
      ],
      "shipment.parcel.width": [
        "Thiếu thông tin chiều rộng"
      ],
      "shipment.parcel.height": [
        "Thiếu thông tin chiều cao"
      ],
      "shipment.parcel.length": [
        "Thiếu thông tin chiều dài"
      ]
    },
    "exception": "The given data failed to pass validation."
  },
  "message": "Unprocessable Entity"
}

Bạn cần điền đầy đủ thông tin để lấy được bảng phí vận chuyển.

Đây là API bắt buộc để có thể tạo vận đơn.