Skip to content

An open-source nodejs library to support shipping managements with giaohangnhanh (ghn.vn)

License

Notifications You must be signed in to change notification settings

lehuygiang28/giaohangnhanh

Repository files navigation

giaohangnhanh

VI | EN

Thư viện mã nguồn mở hỗ trợ quản lý giao hàng với giaohangnhanh (ghn).

Tài liệu từ Ghn: https://api.ghn.vn/home/docs/detail

Cài đặt

Cài đặt giaohangnhanh với npm:

npm install giaohangnhanh

Cài đặt giaohangnhanh với yarn:

yarn add giaohangnhanh

Cài đặt giaohangnhanh với pnpm:

pnpm install giaohangnhanh

Sử dụng

Khởi tạo

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