Rate

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 https://sandbox.goship.io/api/v2/rates

Request body:

{
  "shipment": {
    "address_from": {
      "district": "100100",
      "city": "100000"
    },
    "address_to": {
      "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": "MTFfMjJfNjgzOQ==",
      "carrier_name": "Best Express",
      "carrier_logo": "https://sandbox.goship.io/storage/images/carriers/2022_06_13_16_34_44_badccf2a4495cd91623f437e2c29fe8d.png",
      "carrier_short_name": "best",
      "service": "Nhanh",
      "service_fee": 1540,
      "expected": "Dự kiến giao 2 ngày",
      "cod_fee": 0,
      "discount": 0,
      "insurance_fee": 0,
      "is_apply_only": true,
      "location_fee": 18000,
      "location_first_fee": 18000,
      "location_step_fee": 0,
      "oil_fee": 0,
      "price_table_id": 6839,
      "promotion_id": 0,
      "rate": "MTFfMjJfNjgzOQ==",
      "remote_area_fee": 0,
      "report": {
        "success_percent": 88.6,
        "return_percent": 11.4,
        "avg_time_delivery": 51,
        "avg_time_delivery_format": "51H"
      },
      "return_fee": 9000,
      "shipping_carrier": 16,
      "total_amount": 19540,
      "total_amount_carrier": 0,
      "total_amount_shop": -19540,
      "total_fee": 19540,
      "weight_fee": 0
    }
  ]
}

Trong đó:

• id: ID bảng phí, sử dụng để tạo vận đơn
• rate: Giá trị giống với id, là mã rate được dùng khi submit tạo đơn
• carrier_name: Tên hãng vận chuyển
• carrier_logo: Ảnh logo hãng vận chuyển
• carrier_short_name: Tên viết tắt của đơn vị vận chuyển
• service: Gói dịch vụ Nhanh/Chậm/Tiết kiệm
• service_fee: Phí dịch vụ phụ thu
• expected: Thời gian dự kiến giao hàng
• cod_fee: Phí COD
• insurance_fee: Phí bảo hiểm hàng hóa, bằng 0 nếu không khai giá trị hàng
• location_fee: Phí vận chuyển tính theo khu vực giao hàng
• location_first_fee: Phí cho trọng lượng đầu tiên theo khu vực
• location_step_fee: Phí cộng thêm cho mỗi đơn vị trọng lượng tiếp theo
• oil_fee: Phí xăng dầu phụ thu
• remote_area_fee: Phí vùng xa, bằng 0 nếu địa chỉ không thuộc vùng xa
• return_fee: Phí hoàn hàng nếu giao không thành công
• weight_fee: Phí tính theo trọng lượng gói hàng
• discount: Số tiền giảm trừ từ khuyến mãi hoặc hợp đồng
• promotion_id: Mã khuyến mãi đang áp dụng, bằng 0 nếu không có
• price_table_id: Mã bảng giá đang áp dụng cho lần tính cước này
• shipping_carrier: Mã số nội bộ của đơn vị vận chuyển
• is_apply_only: Boolean, xác định carrier này chỉ áp dụng cho một số điều kiện nhất định
• total_fee: Phí vận chuyển tạm tính
• total_amount: Tổng giá trị đơn hàng
• total_amount_carrier: Tổng phí mà đơn vị vận chuyển thực thu
• total_amount_shop: Phần phí ship shop được hoàn lại hoặc hỗ trợ, thường là số âm
• report: Object chứa thông tin hiệu suất của carrier, gồm:
  • success_percent: Tỷ lệ giao thành công
  • return_percent: Tỷ lệ hoàn hàng
  • avg_time_delivery: Thời gian giao trung bình tính bằng giờ
  • avg_time_delivery_format: Thời gian giao trung bình dạng chuỗi hiển thị

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.