https://github.com/lehuygiang28/giaohangnhanh
An open-source nodejs library to support shipping managements with giaohangnhanh (ghn.vn)
https://github.com/lehuygiang28/giaohangnhanh
ghn giao-hang-nhanh giaohangnhanh
Last synced: 3 months ago
JSON representation
An open-source nodejs library to support shipping managements with giaohangnhanh (ghn.vn)
- Host: GitHub
- URL: https://github.com/lehuygiang28/giaohangnhanh
- Owner: lehuygiang28
- License: mit
- Created: 2024-03-05T11:46:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-27T12:28:26.000Z (11 months ago)
- Last Synced: 2025-03-02T21:38:14.795Z (4 months ago)
- Topics: ghn, giao-hang-nhanh, giaohangnhanh
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/giaohangnhanh
- Size: 122 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# giaohangnhanh
Thư viện mã nguồn mở hỗ trợ quản lý giao hàng với [giaohangnhanh (ghn)](https://ghn.vn).
Tài liệu từ Ghn: [https://api.ghn.vn/home/docs/detail](https://api.ghn.vn/home/docs/detail)
## Cài đặt
Cài đặt `giaohangnhanh` với `npm`:
```bash
npm install giaohangnhanh
```Cài đặt `giaohangnhanh` với `yarn`:
```bash
yarn add giaohangnhanh
```Cài đặt `giaohangnhanh` với `pnpm`:
```bash
pnpm install giaohangnhanh
```## Sử dụng
### Khởi tạo
```ts
import { Ghn } from 'giaohangnhanh';const ghn = new Ghn({
token: 'YOUR_GHN_TOKEN', // Thay bằng token của bạn
shopId: 123456, // Thay bằng shopId của bạn
host: 'https://dev-online-gateway.ghn.vn',
trackingHost: 'https://tracking.ghn.dev/',
testMode: true, // Bật chế độ test sẽ ghi đè tất cả host thành môi trường sandbox
});
```### Các phương thức
Đối tượng
Phương thức
Mô Tả
Trạng thái
address
getProvinces()
Truy vấn tỉnh/thành phố
✅
getDistricts()
Truy vấn quận/huyện
✅
getWards()
Truy vấn phường/xã
✅
calculateFee
getServiceList()
Truy vấn danh sách dịch vụ có sẵn dựa vào địa chỉ giao và nhận
✅
calculateShippingFee()
Truy vấn phí giao hàng
✅
order
calculateExpectedDeliveryTime()
Dự kiến thời gian giao hàng
✅
pickShift()
Danh sách ca lấy đơn hàng
✅
previewOrder()
Xem trước thông tin đơn hàng
✅
createOrder()
Tạo đơn hàng
✅
orderInfo()
Lấy thông tin chi tiết đơn hàng
✅
cancelOrder()
Hủy đơn hàng
✅
getTrackingUrl()
Lấy url theo dõi đơn hàng
✅
_Ghi chú:_
- Biểu tượng ✅ cho biết công việc đã được hoàn thành.
- Biểu tượng 📝 cho biết công việc cần được thực hiện.
- Biểu tượng ❗ cho biết công việc cần sự giúp đỡ.### Code tham khảo: Bấm vào đây
## Contribution