Rate

API tính phí vận chuyển sẽ trả cho chúng ta 1 danh sách các bảng phí vận chuyển tương ứng với từng hãng vận chuyển và dịch vụ của hãng.

Đây là API bắt buộc để có thể tạo vận đơn vận chuyển. Chúng ta sẽ dùng thông tin ID của bảng phí để xác định lựa chọn hãng vận chuyển khi tạo vận đơn.

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

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

Header:

Accept: application/json
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbG.....

Request body:

{
    "shipment": {
        "address_from": {
            "district": "100100",
            "city": "100000"
        },
        "address_from": {
            "district": "100100",
            "city": "100000"
        },
        "parcel": {
            "cod": 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ộ.
  • 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.

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.