Tính phí dịch vụ

API Tính phí dịch vụ

 

Sử dụng API này để tính phí dịch vụ trước khi Tạo đơn qua GHN.

Lưu ý : API này cần truyền token và shopid ở header.

post/get 
https://online-gateway.ghn.vn/shiip/public-api/v2/shipping-order/fee
https://dev-online-gateway.ghn.vn/shiip/public-api/v2/shipping-order/fee
curl --location 'https://dev-online-gateway.ghn.vn/shiip/public-api/v2/shipping-order/fee' \
    --header 'Content-Type: application/json' \
    --header 'Token: c518-c4bb-11ea-be3a-f636b1deefb9' \
    --header 'ShopId: 885' \
    --data '{
    "service_type_id":5,
    "from_district_id":1442,
    "from_ward_code": "21211",
    "to_district_id":1820,
    "to_ward_code":"030712",
    "height":20,
    "length":30,
    "weight":3000,
    "width":40,
    "insurance_value":0,
    "coupon": null,
    "items": [
            {
                "name": "TEST1",
                "quantity": 1,
                "height": 200,
                "weight": 1000,
                "length": 200,
                "width": 200
            }
                ]
    }'

Cấu trúc Request

Trường dữ liệu Bắt buộc Kiểu dữ liệu Mô tả
token X String

Dùng để xác định định danh của tài khoản và dùng cho các trường hợp gọi tới các API.
shop_id X Int

Mã định danh của cửa hàng.
service_id   Int

Để lấy thông tin chính xác từng dịch vụ phù hợp với tuyến đường nên gọi API lấy gói dịch vụ

Lưu ý: Nếu đã truyền service_type_id thì không cần truyền service_id.
service_type_id   Int

Mã loại dịch vụ: Gọi API lấy gói dịch vụ để lấy mã loại dịch vụ.

Mã loại dịch vụ cố định. Trong đó:  2:Chuyển phát thương mại điện tử

Lưu ý: Nếu đã truyền service_id thì không cần truyền service_type_id .
insurance_value   Int

Giá trị của đơn hàng ( Trường hợp mất hàng, bể hàng sẽ đền theo giá trị của đơn hàng).

Tối đa 5.000.000

Giá trị mặc định: 0
coupon   String

Mã giảm giá.
cod_failed_amount   Int

Giá trị giao thất bại thu tiền .
from_district_id   Int

Mã Quận/Huyện người gửi hàng.

Nếu không truyền sẽ lấy thông tin từ ShopId
from_ward_code   String

Mã Phường/Xã người nhận hàng.

Nếu không truyền sẽ lấy thông tin từ ShopId
to_ward_code X String

Mã Phường/Xã người nhận hàng.
to_district_id X Int

Mã Quận/Huyện người nhận hàng.
weight X Int

Khối lượng của đơn hàng (gram).

Tối đa : 1600000 gram
length   Int

Chiều dài của đơn hàng (cm).

Tối đa : 200 cm
width   Int

Chiều rộng của đơn hàng (cm).

Tối đa : 200 cm
height   Int

Chiều cao của đơn hàng (cm).

Tối đa : 200 cm
cod_value   Int

Tiền thu hộ cho người gửi.

Maximum :10.000.000

Giá trị mặc định: 0
items X  

Thông tin sản phẩm.

Bắt buộc truyền Item khi sử dụng gói dịch vụ Chuyển phát truyền thống
name X String

Tên của sản phẩm.
code   String

Mã của sản phẩm.
quantity X Int

Số lượng của sản phẩm.
height X Int

Chiều cao của sản phẩm chuyển phát truyền thống đi nhiều kiện thì bắt buộc phải truyền height .
weight X Int

Đối với trường hợp chọn gói dịch chuyển phát truyền thống đi nhiều kiện thì bắt buộc phải truyền weight .
width X Int

Chiều rộng của sản phẩm chuyển phát truyền thống đi nhiều kiện thì bắt buộc phải truyền width .
length X Int

Chiều dài của sản phẩm chuyển phát truyền thống đi nhiều kiện thì bắt buộc phải truyền length .

  • Success 200

{
                                    "code": 200,
                                    "message": "Success",
                                    "data":{
                                    "total":36300,
                                    "service_fee":36300,
                                    "insurance_fee":0,
                                    "pick_station_fee":0,
                                    "coupon_value":0,
                                    "r2s_fee":0,
                                    "document_return":0,
                                    "double_check":0,
                                    "cod_fee":0,
                                    "pick_remote_areas_fee":0,
                                    "deliver_remote_areas_fee":0,
                                    "cod_failed_fee":0,
                                    }
                                }

Cấu trúc Response

Trường dữ liệu Mô tả
total

Tổng tiền dịch vụ.
service_fee

Phí dịch vụ.
insurance_fee

Phí khai giá hàng hóa.
pick_station_fee

Phí gửi hàng tại bưu cục.
coupon_value

Giá trị khuyến mãi.
r2s_fee

Phí giao lại hàng.
document_return

Phí giao tài liệu
double_check

Phí đồng kiểm.
cod_fee

Phí thu tiền COD
pick_remote_areas_fee

Phí lấy hàng vùng xa.
deliver_remote_areas_fee

Phí giao hàng vùng xa.
cod_failed_fee

Phí thu tiền khi giao thất bại.

 
{
                                    "code": 400,
                                    "message": "code=400, message=Syntax error: offset=30, error=invalid character '}' after array element, internal=invalid character '}' after array element",
                                    "data": null
                                    "code_message": "USER_ERR_COMMON"
                                }