Shipping API - Tính phí

API trả về dữ liệu danh sách phí cho các loại dịch vụ của đối tác giao hàng.

Các thông tin cấu hình cần thiết:

Tên	Mô tả
CompanyCode	Mã cửa hàng lấy
AccessToken	Chuỗi token xác thực
Environment	Sub path để gọi request tới api lấy dữ liệu

Để lấy các thông tin trên xem bài viết account/login

About

URL	Phiên bản	Thay đổi
graphapi.mshopkeeper.vn/{Environment}	1.0.0.8	Danh sách phí theo loại dịch vụ
graphapi.mshopkeeper.vn/{Environment}	1.0

Schemes

Scheme
https

Endpoints

api/v1/shipping/calculate-all

POST

Tính phí

Expected Response Types

HttpCode	ServiceResult.ErrorType	Mô tả
401		Chuỗi AccessToken hết hạn hoặc không hợp lệ cần phải gọi cấp phát lại
200	0	Không có lỗi
200	1	Tham số không hợp lệ null or empty
200	2	Mã cửa hàng không tồn tại
200	7	Thiết lập kết nối MShopKeeper đang ở trạng thái ngắt, không thể lấy dữ liệu
200	100	Lỗi nội bộ API Graph
200	102	Request bị từ chối, do có request cùng loại đang xử lý. Vui lòng chờ xử lý xong hoặc chờ request đang xử lý timeout thì gọi lại.

Parameters

Name	In	Description	Required?	Type
param	body	Đối tượng tính phí	true	CalculateFeeRequestParam

Headers (gửi lên theo header field)

Name	In	Description	Required?	Type
Authorization	header	Header key cấu hình AccessToken (dạng `Bearer AccessToken`)	true	string
CompanyCode	header	Header key cấu hình mã cửa hàng CompanyCode	true	string

Ví dụ:

CompanyCode: demoquanao
Authorization: Bearer 06S1YMPgDJl65xE5tYzAJlNmVALHVHlLZg9euMUaUTO9C0Jm8TL3L4isto97ApKdQbVVX2rUJUTfXbBBipo1B5UvAgl3hwDYh8bNGVVUNp6B99Ht3KZQkwVh2SNblX-vulGSNatV-NF1KOfNJImOUsVXimxVEX3n2lnRV0A_mbJ_XP0sliGqbMzwa9YtY-jts4Iu06TaFOqBpBhndS-mofDlZlKkVqYklwy6cDzBktas7Xfi5MOsCujCDYO_0WFauBQCPDVnSj6ew_3Nm5ollwynkmErSmVf2E4cShM4700

Content Types Produced

Produces
application/json

Content Types Consumed

Consumes
application/json

Response

Trả về đối tượng ServiceResult với ServiceResult.Data là Array<FeeInfo> tổng số dịch vụ tính phí có trong hệ thống qua ServiceResult.Total

Example

Ví dụ gửi tham số gọi tới api

JSON CalculateFeeRequestParam

{
  "Weight": 300,
  "Length": 10,
  "Width": 10,
  "Height": 10,
  "From": {
    "Address": "111 Tô Hiệu, Hà Nội",
    "ProvinceId": "VN101",
    "GHNProvinceId": 0,
    "DistrictId": "VN10113",
    "GHNDistrictId": 0,
    "WardId": "VN1011313",
    "GHNWardId": 0,
    "Longitude": 0.0,
    "Latitude": 0.0
  },
  "To": {
    "Address": "78 Tô Hiệu",
    "ProvinceId": "VN101",
    "GHNProvinceId": 0,
    "DistrictId": "VN10101",
    "GHNDistrictId": 0,
    "WardId": "VN1010101",
    "GHNWardId": 0,
    "Longitude": 0.0,
    "Latitude": 0.0
  },
  "IsCOD": false,
  "TotalAmount": 0,
  "ServiceID": "",
  "ShippingPaymentType": 1,
  "PickupType": 1,
  "InsuranceFee": 0,
  "BranchAddress": "Kho dvbinh - N03-T1 Ngoại giao đoàn, Phường Nghĩa Tân, Quận Cầu Giấy, Hà Nội",
  "PickupAddressID": "590395",
  "UseBaoPhat": false,
  "UseHoaDon": false,
  "ProductValue": 120000.0,
  "OrderPickWorkShift": 0,
  "CaculateAll": false,
  "IntegrationApplication": "MSHOPKEEPER",
  "CompanyCode": "dvbinh",
  "BranchId": "4acab834-5947-41c7-a4db-23f7c873b9e3",
  "Partner": "GHN"
}

Hệ thống sẽ trả về ServiceResult với Data là Array<FeeInfo> JSON response

{
  "Code": 200,
  "Data": [
    {
      "PartnerID": "GHN",
      "PartnerName": "Giao hàng nhanh",
      "ServiceID": "53319",
      "ServiceName": "Nhanh",
      "Description": null,
      "TotalFee": 70000.0,
      "CodAmount": 0.0,
      "Success": true,
      "StatusCode": 0,
      "MShopShippingPartnerID": null,
      "MShopVendorName": null,
      "Inactive": false,
      "ExtraServices": null,
      "ExtraFee": 0.0,
      "ServiceExtendFee": 0.0,
      "VasFee": 0.0,
      "VatFee": 0.0,
      "MainFee": 30000.0,
      "CoDFee": 0.0,
      "InsuranceFee": 29000.0
    },
    {
      "PartnerID": "GHN",
      "PartnerName": "Giao hàng nhanh",
      "ServiceID": "53320",
      "ServiceName": "Chuẩn",
      "Description": null,
      "TotalFee": 70000.0,
      "CodAmount": 0.0,
      "Success": true,
      "StatusCode": 0,
      "MShopShippingPartnerID": null,
      "MShopVendorName": null,
      "Inactive": false,
      "ExtraServices": null,
      "ExtraFee": 0.0,
      "ServiceExtendFee": 0.0,
      "VasFee": 0.0,
      "VatFee": 0.0,
      "MainFee": 30000.0,
      "CoDFee": 0.0,
      "InsuranceFee": 29000.0
    },
    {
      "PartnerID": "GHN",
      "PartnerName": "Giao hàng nhanh",
      "ServiceID": "53321",
      "ServiceName": "Tiết kiệm",
      "Description": null,
      "TotalFee": 70000.0,
      "CodAmount": 0.0,
      "Success": true,
      "StatusCode": 0,
      "MShopShippingPartnerID": null,
      "MShopVendorName": null,
      "Inactive": false,
      "ExtraServices": null,
      "ExtraFee": 0.0,
      "ServiceExtendFee": 0.0,
      "VasFee": 0.0,
      "VatFee": 0.0,
      "MainFee": 30000.0,
      "CoDFee": 0.0,
      "InsuranceFee": 29000.0
    }
  ],
  "Total": 3,
  "Success": true,
  "Environment": "g1"
}

Definitions

CalculateFeeRequestParam Definition

Tham số tính phí

Property	Type	Format	Mô tả
Weight	int		Trọng lượng của kiện hàng
Length	int		Chiều dài của kiện
Width	int		Chiều ngang của kiện
Height	int		Chiều cao của kiện
From	Location		Địa chỉ giao hàng từ
To	Location		Địa chỉ giao hàng tới
IsCOD	bool		Đơn hàng có thu COD hay không
TotalAmount	long		Tổng số tiền cần thanh toán
ShippingPaymentType	int		Hình thức trả: 0:Khách trả, 1:Shop trả
PickupType	int		Danh sách các loại giao vận mà đối tác giao vận có hỗ trợ đối với đơn hàng: 1:Shipper đến nhận hàng, 2:Cửa hàng tự giao hàng cho bưu cục
CouponCode	string		Mã khuyến mãi được sử dụng
ServiceID	string		ID dịch vụ được lựa chọn
InsuranceFee	int		Phí bảo hiểm của kiện hàng
BranchAddress	string		Địa chỉ chi nhánh
PickupAddressID	string		thông tin ID shop
IntegrationApplication	string		Mã ứng dụng (VD: "MSHOPKEEPER")
CompanyCode	string		domain
BranchID	string	guid	ID cửa hàng
Partner	string		Mã đối tác

Location Definition

Property	Type	Mô tả
Address	string	Địa chỉ
ProvinceId	string	ID tỉnh/thành
ProvinceName	string	Tên tỉnh/thành
GHNProvinceId	int	ID tỉnh/thành trên GHN
DistrictId	string	ID quận/huyện
DistrictName	string	Tên quận/huyện
GHNDistrictId	int	ID quận/huyện trên GHN
WardId	string	ID phường/xã
WardName	string	Tên phường/xã
GHNWardId	int	ID phường/xã trên GHN
Longitude	double
Latitude	double

FeeInfo Definition

Property	Type	Mô tả
PartnerID	string	Mã đối tác
PartnerName	string	Tên đối tác hàng
ServiceID	string	ID dịch vụ hàng
ServiceName	string	Tên dịch vụ thoại
Description	string	Mô tả
TotalFee	long	Tổng phí
CodAmount	long
ServiceExtendFee	long
VasFee	long
VatFee	long
MainFee	long
CoDFee	long
InsuranceFee	long

ServiceResult Definition

Property	Type	Format	Mô tả
Code	int		Mã lỗi HttpCode (200, 500...)
ErrorType	int		Loại lỗi
ErrorMessage	string		Thông tin lỗi
Success	bool		True - không có lỗi logic xảy ra
Environment	string		Môi trường triển khai của api
Data	string	object	Dữ liệu trả về client
Total	int		Tổng số bản ghi khi lấy dữ liệu phân trang

ErrorType Definition

Dải mã lỗi chung

HttpCode	ServiceResult.ErrorType	Mô tả
401		Chuỗi AccessToken hết hạn hoặc không hợp lệ cần phải gọi cấp phát lại
200	0	Không có lỗi
200	1	Tham số không hợp lệ null or empty
200	2	Mã cửa hàng không tồn tại
200	3	Mã Appid không tồn tại trên hệ thống
200	4	Chuỗi thông tin chữ ký đăng nhập không hợp lệ, timeout
200	7	Thiết lập kết nối MShopKeeper đang ở trạng thái ngắt, không thể lấy dữ liệu

Dải mã lỗi nghiêm trọng

HttpCode	ServiceResult.ErrorType	Mô tả
200	100	Lỗi nội bộ API Graph
200	102	Request bị từ chối, do có request cùng loại đang xử lý. Vui lòng chờ xử lý xong hoặc chờ request đang xử lý timeout thì gọi lại. Ví dụ: Khi đang gọi api login mà api chưa trả về dữ liệu lại tiếp tục gọi request login này sẽ trả về lỗi này.