tringuyenduc2903/giaohangnhanh

GiaoHangNhanh SDK for Laravel Framework

Maintainers

Details

github.com/tringuyenduc2903/GiaoHangNhanh

Homepage

Source

Issues

Fund package maintenance!
Nguyễn Đức Trí

Installs: 1

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

1.0.0 2024-10-22 01:53 UTC

Requires

Requires (Dev)

MIT 3db53de4cccf8f502478f2411725372f1e5000ba

  • Nguyễn Đức Trí <nguyenductri2k3.woop@gmail.com>

laravelNguyễn Đức Trígiaohangnhanh

This package is auto-updated.

Last update: 2024-10-22 02:07:36 UTC

README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Requirements

  • Laravel 11+
  • PHP 8.2+

Installation

You can install the package via composer:

composer require tringuyenduc2903/giaohangnhanh

You can publish the config file with:

php artisan vendor:publish --tag="giaohangnhanh-config"

This is the contents of the published config file:

return [
    // For Dev:  https://dev-online-gateway.ghn.vn
    // For Prod: https://online-gateway.ghn.vn
    'api_url' => env('GHN_API_URL', 'https://online-gateway.ghn.vn'),

    // For Dev:  https://tracking.ghn.dev
    // For Prod: https://donhang.ghn.vn
    'tracking_url' => env('GHN_TRACKING_URL', 'https://donhang.ghn.vn'),

    'token' => env('GHN_TOKEN'),

    'shop_id' => env('GHN_SHOP_ID'),

    'shop_district_id' => env('GHN_SHOP_DISTRICT_ID'),
];

Usage

Preview Order

Helps preview order information without creating an order

\GiaoHangNhanh::previewOrder([
    'from_name' => $from_name,
    'from_phone' => $from_phone,
    'from_address' => $from_address,
    'from_ward_name' => $from_ward_name,
    'from_district_name' => $from_district_name,
    'from_province_name' => $from_province_name,
    'from_ward_code' => $from_ward_code,
    'from_district_id' => $from_district_id,
    'from_province_id' => $from_province_id,
    'to_name' => $to_name,
    'to_phone' => $to_phone,
    'to_address' => $to_address,
    'to_ward_name' => $to_ward_name,
    'to_district_name' => $to_district_name,
    'to_ward_code' => $to_ward_code,
    'to_district_id' => $to_district_id,
    'return_phone' => $return_phone,
    'return_address' => $return_address,
    'return_ward_name' => $return_ward_name,
    'return_district_name' => $return_district_name,
    'return_ward_code' => $return_ward_code,
    'return_district_id' => $return_district_id,
    'client_order_code' => $client_order_code,
    'cod_amount' => $cod_amount,
    'content' => $content,
    'weight' => $weight,
    'length' => $length,
    'width' => $width,
    'height' => $height,
    'pick_station_id' => $pick_station_id,
    'insurance_value' => $insurance_value,
    'coupon' => $coupon,
    'service_type_id' => $service_type_id,
    'payment_type_id' => $payment_type_id,
    'note' => $note,
    'required_note' => $required_note,
    'pick_shift' => $pick_shift,
    'pick_shift' => $pick_shift,
    'pickup_time' => $pickup_time,
    'items' => $items,
    'cod_failed_amount' => $cod_failed_amount,
]);
return [
    'order_code' => '',
    'sort_code' => 'B-100-U-02-A5',
    'trans_type' => 'truck',
    'ward_encode' => '',
    'district_encode' => '',
    'fee' => [
        'main_service' => 88996,
        'insurance' => 20879,
        'cod_fee' => 0,
        'station_do' => 0,
        'station_pu' => 0,
        'return' => 0,
        'r2s' => 0,
        'return_again' => 0,
        'coupon' => 0,
        'document_return' => 0,
        'double_check' => 0,
        'double_check_deliver' => 0,
        'pick_remote_areas_fee' => 0,
        'deliver_remote_areas_fee' => 0,
        'pick_remote_areas_fee_return' => 0,
        'deliver_remote_areas_fee_return' => 0,
        'cod_failed_fee' => 0,
    ],
    'total_fee' => 109875,
    'expected_delivery_time' => '2024-10-24T23:59:59Z',
    'operation_partner' => '',
];

Create Order

Automatic send order information such as weight, address, phone number and many more to GHN system. We will process these information and start the shipment

\GiaoHangNhanh::createOrder([
    'from_name' => $from_name,
    'from_phone' => $from_phone,
    'from_address' => $from_address,
    'from_ward_name' => $from_ward_name,
    'from_district_name' => $from_district_name,
    'from_province_name' => $from_province_name,
    'from_ward_code' => $from_ward_code,
    'from_district_id' => $from_district_id,
    'from_province_id' => $from_province_id,
    'to_name' => $to_name,
    'to_phone' => $to_phone,
    'to_address' => $to_address,
    'to_ward_name' => $to_ward_name,
    'to_district_name' => $to_district_name,
    'to_ward_code' => $to_ward_code,
    'to_district_id' => $to_district_id,
    'return_phone' => $return_phone,
    'return_address' => $return_address,
    'return_ward_name' => $return_ward_name,
    'return_district_name' => $return_district_name,
    'return_ward_code' => $return_ward_code,
    'return_district_id' => $return_district_id,
    'client_order_code' => $client_order_code,
    'cod_amount' => $cod_amount,
    'content' => $content,
    'weight' => $weight,
    'length' => $length,
    'width' => $width,
    'height' => $height,
    'pick_station_id' => $pick_station_id,
    'insurance_value' => $insurance_value,
    'coupon' => $coupon,
    'service_type_id' => $service_type_id,
    'payment_type_id' => $payment_type_id,
    'note' => $note,
    'required_note' => $required_note,
    'pick_shift' => $pick_shift,
    'pick_shift' => $pick_shift,
    'pickup_time' => $pickup_time,
    'items' => $items,
    'cod_failed_amount' => $cod_failed_amount,
]);
return [
    'order_code' => 'Order code (Hided)',
    'sort_code' => '400-B-02-C4',
    'trans_type' => 'truck',
    'ward_encode' => '',
    'district_encode' => '',
    'fee' => [
        'main_service' => 249508,
        'insurance' => 13070,
        'cod_fee' => 0,
        'station_do' => 0,
        'station_pu' => 0,
        'return' => 0,
        'r2s' => 0,
        'return_again' => 0,
        'coupon' => 0,
        'document_return' => 0,
        'double_check' => 0,
        'double_check_deliver' => 0,
        'pick_remote_areas_fee' => 0,
        'deliver_remote_areas_fee' => 0,
        'pick_remote_areas_fee_return' => 0,
        'deliver_remote_areas_fee_return' => 0,
        'cod_failed_fee' => 0,
    ],
    'total_fee' => 262578,
    'expected_delivery_time' => '2024-10-23T23:59:59Z',
    'operation_partner' => '',
];

Update Order

Update information of created order. Only available when shipping status

\GiaoHangNhanh::updateOrder([
    'order_code' => $order_code,
    'from_name' => $from_name,
    'from_phone' => $from_phone,
    'from_address' => $from_address,
    'from_ward_name' => $from_ward_name,
    'from_district_name' => $from_district_name,
    'from_province_name' => $from_province_name,
    'from_ward_code' => $from_ward_code,
    'from_district_id' => $from_district_id,
    'from_province_id' => $from_province_id,
    'to_name' => $to_name,
    'to_phone' => $to_phone,
    'to_address' => $to_address,
    'to_ward_name' => $to_ward_name,
    'to_district_name' => $to_district_name,
    'to_ward_code' => $to_ward_code,
    'to_district_id' => $to_district_id,
    'return_phone' => $return_phone,
    'return_address' => $return_address,
    'return_ward_name' => $return_ward_name,
    'return_district_name' => $return_district_name,
    'return_ward_code' => $return_ward_code,
    'return_district_id' => $return_district_id,
    'client_order_code' => $client_order_code,
    'content' => $content,
    'weight' => $weight,
    'length' => $length,
    'width' => $width,
    'height' => $height,
    'pick_station_id' => $pick_station_id,
    'insurance_value' => $insurance_value,
    'coupon' => $coupon,
    'payment_type_id' => $payment_type_id,
    'note' => $note,
    'required_note' => $required_note,
    'pick_shift' => $pick_shift,
    'pick_shift' => $pick_shift,
    'pickup_time' => $pickup_time,
    'items' => $items,
]);
return null;

Update COD of Order

Update value for COD

\GiaoHangNhanh::updateCodOrder([
    'order_code' => $order_code,
    'cod_amount' => $insurance_value,
]);
return null;

Order Info

This API help you get all information of a order. You can know current status or the reason which make the shipment failed

\GiaoHangNhanh::orderInfo($order_code);
return [
    'shop_id' => 5353886,
    'client_id' => 164936,
    'return_name' => 'Store Name (Hided)',
    'return_phone' => 'Store Phone (Hided)',
    'return_address' => 'Store Address (Hided)',
    'return_ward_code' => 'Store Ward Code (Hided)',
    'return_district_id' => 1490,
    'return_location' => [
        'lat' => 20.9922261,
        'long' => 105.8623596,
        'cell_code' => 'AHTAZZD5',
        'place_id' => 'Store Place Id (Hided)',
        'trust_level' => 5,
        'wardcode' => 'Store Ward Code (Hided)',
    ],
    'from_name' => 'Store Name (Hided)',
    'from_phone' => 'Store Phone (Hided)',
    'from_hotline' => '',
    'from_address' => 'Store Address (Hided)',
    'from_ward_code' => 'Store Ward Code (Hided)',
    'from_district_id' => 1490,
    'from_location' => [
        'lat' => 20.9922261,
        'long' => 105.8623596,
        'cell_code' => 'AHTAZZD5',
        'place_id' => 'Store Place Id (Hided)',
        'trust_level' => 5,
        'wardcode' => 'Store Ward Code (Hided)',
    ],
    'deliver_station_id' => 0,
    'to_name' => 'Lê Diệu Công',
    'to_phone' => '0346416430',
    'to_address' => "\"\"
    829 Little Squares\n
    East Bianka, IN 89167-6684
\"\"",
    'to_ward_code' => '190814',
    'to_district_id' => 1969,
    'to_location' => [
        'lat' => 21.019662626329,
        'long' => 106.24778397527,
        'cell_code' => 'AIMBAALC',
        'trust_level' => 5,
        'wardcode' => '190814',
    ],
    'weight' => 21000,
    'length' => 100,
    'width' => 64,
    'height' => 48,
    'converted_weight' => 48840,
    'calculate_weight' => 56080,
    'image_ids' => null,
    'service_type_id' => 5,
    'service_id' => 100039,
    'payment_type_id' => 1,
    'payment_type_ids' => [
        0 => 1,
    ],
    'custom_service_fee' => 0,
    'sort_code' => '400-C-02-C4',
    'cod_amount' => 0,
    'cod_collect_date' => null,
    'cod_transfer_date' => null,
    'is_cod_transferred' => false,
    'is_cod_collected' => false,
    'insurance_value' => 1306961,
    'order_value' => 0,
    'pick_station_id' => 0,
    'client_order_code' => 'Client order code (Hided)',
    'cod_failed_amount' => 0,
    'cod_failed_collect_date' => null,
    'required_note' => 'CHOTHUHANG',
    'content' => 'Sản phẩm 1 [1 kiện], Sản phẩm 2 [1 kiện]',
    'note' => '',
    'employee_note' => '',
    'seal_code' => '',
    'pickup_time' => '2024-10-21T04:53:27.24Z',
    'items' => [
        0 => [
            'name' => 'Sản phẩm 1',
            'quantity' => 1,
            'length' => 50,
            'width' => 12,
            'height' => 23,
            'category' => [],
            'weight' => 10000,
            'status' => '',
            'item_order_code' => 'Order code (Hided)_1',
        ],
        1 => [
            'name' => 'Sản phẩm 2',
            'quantity' => 1,
            'length' => 64,
            'width' => 100,
            'height' => 36,
            'category' => [],
            'weight' => 11000,
            'status' => '',
            'item_order_code' => 'Order code (Hided)_2',
        ],
    ],
    'coupon' => '',
    'coupon_campaign_id' => 0,
    '_id' => 'Id (Hided)',
    'order_code' => 'Order code (Hided)',
    'version_no' => 'fbd0cec0-2bf1-4f98-b8d5-f69e72c18bee',
    'updated_ip' => '171.224.178.226',
    'updated_employee' => 0,
    'updated_client' => 164936,
    'updated_source' => 'shiip',
    'updated_date' => '2024-10-21T04:53:28.11Z',
    'updated_warehouse' => 0,
    'created_ip' => '171.224.178.226',
    'created_employee' => 0,
    'created_client' => 164936,
    'created_source' => 'shiip',
    'created_date' => '2024-10-21T04:53:27.153Z',
    'status' => 'ready_to_pick',
    'internal_process' => [
        'status' => '',
        'type' => '',
    ],
    'pick_warehouse_id' => 21429000,
    'deliver_warehouse_id' => 20969000,
    'current_warehouse_id' => 21429000,
    'return_warehouse_id' => 21429000,
    'next_warehouse_id' => 0,
    'current_transport_warehouse_id' => 0,
    'leadtime' => '2024-10-23T23:59:59Z',
    'order_date' => '2024-10-21T04:53:27.24Z',
    'data' => [],
    'soc_id' => '6715de4780c6e6ad120515da',
    'finish_date' => null,
    'tag' => [
        0 => 'bulky',
        1 => 'multiple',
        2 => 'truck',
    ],
    'is_partial_return' => false,
    'is_document_return' => false,
    'pickup_shift' => [],
    'transaction_ids' => [
        0 => '8c615700-41c7-42cc-9110-5edbb48655d2',
    ],
    'transportation_status' => '',
    'transportation_phase' => '',
    'extra_service' => [
        'document_return' => null,
        'double_check' => false,
    ],
    'config_fee_id' => '66c59e887e9ffb387092daa8',
    'extra_cost_id' => '65dedfd6b5bd2050b45c0ddf',
    'standard_config_fee_id' => '66c59e887e9ffb387092daa8',
    'standard_extra_cost_id' => '65dedfd6b5bd2050b45c0ddf',
    'ecom_config_fee_id' => 0,
    'ecom_extra_cost_id' => 0,
    'ecom_standard_config_fee_id' => 0,
    'ecom_standard_extra_cost_id' => 0,
    'is_b2b' => false,
    'operation_partner' => '',
    'process_partner_name' => '',
    'type_order' => 'freight',
    'type_order_code' => 'FSME',
];

Order Info by Client_Order_Code

This API help you get all information of a order. You can know current status or the reason which make the shipment failed

\GiaoHangNhanh::orderInfoByClientOrderCode($client_order_code);
return [
    'shop_id' => 5353886,
    'client_id' => 164936,
    'return_name' => 'Store Name (Hided)',
    'return_phone' => 'Store Phone (Hided)',
    'return_address' => 'Store Address (Hided)',
    'return_ward_code' => 'Store Ward Code (Hided)',
    'return_district_id' => 1490,
    'return_location' => [
        'lat' => 20.9922261,
        'long' => 105.8623596,
        'cell_code' => 'AHTAZZD5',
        'place_id' => 'Store Place Id (Hided)',
        'trust_level' => 5,
        'wardcode' => 'Store Ward Code (Hided)',
    ],
    'from_name' => 'Store Name (Hided)',
    'from_phone' => 'Store Phone (Hided)',
    'from_hotline' => '',
    'from_address' => 'Store Address (Hided)',
    'from_ward_code' => 'Store Ward Code (Hided)',
    'from_district_id' => 1490,
    'from_location' => [
        'lat' => 20.9922261,
        'long' => 105.8623596,
        'cell_code' => 'AHTAZZD5',
        'place_id' => 'Store Place Id (Hided)',
        'trust_level' => 5,
        'wardcode' => 'Store Ward Code (Hided)',
    ],
    'deliver_station_id' => 0,
    'to_name' => 'Lê Diệu Công',
    'to_phone' => '0346416430',
    'to_address' => "\"\"
829 Little Squares\n
East Bianka, IN 89167-6684
\"\"",
    'to_ward_code' => '190814',
    'to_district_id' => 1969,
    'to_location' => [
        'lat' => 21.019662626329,
        'long' => 106.24778397527,
        'cell_code' => 'AIMBAALC',
        'trust_level' => 5,
        'wardcode' => '190814',
    ],
    'weight' => 21000,
    'length' => 100,
    'width' => 64,
    'height' => 48,
    'converted_weight' => 48840,
    'calculate_weight' => 56080,
    'image_ids' => null,
    'service_type_id' => 5,
    'service_id' => 100039,
    'payment_type_id' => 1,
    'payment_type_ids' => [
        0 => 1,
    ],
    'custom_service_fee' => 0,
    'sort_code' => '400-C-02-C4',
    'cod_amount' => 0,
    'cod_collect_date' => null,
    'cod_transfer_date' => null,
    'is_cod_transferred' => false,
    'is_cod_collected' => false,
    'insurance_value' => 1306961,
    'order_value' => 0,
    'pick_station_id' => 0,
    'client_order_code' => 'Client order code (Hided)',
    'cod_failed_amount' => 0,
    'cod_failed_collect_date' => null,
    'required_note' => 'CHOTHUHANG',
    'content' => 'Sản phẩm 1 [1 kiện], Sản phẩm 2 [1 kiện]',
    'note' => '',
    'employee_note' => '',
    'seal_code' => '',
    'pickup_time' => '2024-10-21T04:53:27.24Z',
    'items' => [
        0 => [
            'name' => 'Sản phẩm 1',
            'quantity' => 1,
            'length' => 50,
            'width' => 12,
            'height' => 23,
            'category' => [],
            'weight' => 10000,
            'status' => '',
            'item_order_code' => 'Order code (Hided)_1',
        ],
        1 => [
            'name' => 'Sản phẩm 2',
            'quantity' => 1,
            'length' => 64,
            'width' => 100,
            'height' => 36,
            'category' => [],
            'weight' => 11000,
            'status' => '',
            'item_order_code' => 'Order code (Hided)_2',
        ],
    ],
    'coupon' => '',
    'coupon_campaign_id' => 0,
    '_id' => 'Id (Hided)',
    'order_code' => 'Order code (Hided)',
    'version_no' => 'fbd0cec0-2bf1-4f98-b8d5-f69e72c18bee',
    'updated_ip' => '171.224.178.226',
    'updated_employee' => 0,
    'updated_client' => 164936,
    'updated_source' => 'shiip',
    'updated_date' => '2024-10-21T04:53:28.11Z',
    'updated_warehouse' => 0,
    'created_ip' => '171.224.178.226',
    'created_employee' => 0,
    'created_client' => 164936,
    'created_source' => 'shiip',
    'created_date' => '2024-10-21T04:53:27.153Z',
    'status' => 'ready_to_pick',
    'internal_process' => [
        'status' => '',
        'type' => '',
    ],
    'pick_warehouse_id' => 21429000,
    'deliver_warehouse_id' => 20969000,
    'current_warehouse_id' => 21429000,
    'return_warehouse_id' => 21429000,
    'next_warehouse_id' => 0,
    'current_transport_warehouse_id' => 0,
    'leadtime' => '2024-10-23T23:59:59Z',
    'order_date' => '2024-10-21T04:53:27.24Z',
    'data' => [],
    'soc_id' => '6715de4780c6e6ad120515da',
    'finish_date' => null,
    'tag' => [
        0 => 'bulky',
        1 => 'multiple',
        2 => 'truck',
    ],
    'is_partial_return' => false,
    'is_document_return' => false,
    'pickup_shift' => [],
    'transaction_ids' => [
        0 => '8c615700-41c7-42cc-9110-5edbb48655d2',
    ],
    'transportation_status' => '',
    'transportation_phase' => '',
    'extra_service' => [
        'document_return' => null,
        'double_check' => false,
    ],
    'config_fee_id' => '66c59e887e9ffb387092daa8',
    'extra_cost_id' => '65dedfd6b5bd2050b45c0ddf',
    'standard_config_fee_id' => '66c59e887e9ffb387092daa8',
    'standard_extra_cost_id' => '65dedfd6b5bd2050b45c0ddf',
    'ecom_config_fee_id' => 0,
    'ecom_extra_cost_id' => 0,
    'ecom_standard_config_fee_id' => 0,
    'ecom_standard_extra_cost_id' => 0,
    'is_b2b' => false,
    'operation_partner' => '',
    'process_partner_name' => '',
    'type_order' => 'freight',
    'type_order_code' => 'FSME',
];

Return Order

The purpose of changing the status of an order to delivery is only applicable where the current status of the order is: storage or waiting for delivery

\GiaoHangNhanh::returnOrder([$order_code]);
return [
    'order_code' => 'Order code (Hided)',
    'result' => true,
    'message' => 'OK',
];

Delivery Again

  • Orders that have been repeatedly delivered are unsuccessful, will go into waiting for delivery (waiting time for delivery depends on each customer's contract, the default is 24h)
  • During this period, customer can request delivery of the order again, order status after delivery request will become "storage"
\GiaoHangNhanh::deliveryAgain([$order_code]);
return [
    'order_code' => 'Order code (Hided)',
    'result' => true,
    'message' => 'OK',
];

Print Order

\GiaoHangNhanh::printOrder([$order_code]);
return [
    'A5' => 'https://online-gateway.ghn.vn/a5/public-api/printA5?token=32dd2311-8f6e-11ef-aa80-fa22946d6b9f',
    '80x80' => 'https://online-gateway.ghn.vn/a5/public-api/print80x80?token=32dd2311-8f6e-11ef-aa80-fa22946d6b9f',
    '52x70' => 'https://online-gateway.ghn.vn/a5/public-api/print52x70?token=32dd2311-8f6e-11ef-aa80-fa22946d6b9f',
];

Cancel Order

Cancel a shipping order from GHN

\GiaoHangNhanh::cancelOrder([$order_code]);
return [
    'order_code' => 'Order code (Hided)',
    'result' => true,
    'message' => 'OK',
];

Get Station

Get GHN Station data. This API provides station_id to create shipping order

\GiaoHangNhanh::getStation(
    [
        'ward_code' => $ward_code,
        'district_id' => (string) $district_id,
        'offset' => $offset,
        'limit' => $limit,
    ],
    $token
);
return [
    0 => [
        'address' => "40 Nguyễn Văn Linh, Thị trấn Ea T'Ling, Huyện Cư Jút, Tỉnh Đăk Nông",
        'locationCode' => '20673000',
        'locationId' => 20673000,
        'locationName' => 'Bưu Cục 40 Nguyễn Văn Linh-Cư Jút-Đắk Nông',
        'parentLocation' => [
            0 => 'PROVINCE/241',
            1 => 'DISTRICT/3152',
            2 => 'WARD/630401',
            3 => 'REGION/H',
        ],
        'email' => '',
        'latitude' => 12.591587,
        'longitude' => 107.896341,
        'wardName' => "Thị trấn Ea T'Ling",
        'districtName' => 'Huyện Cư Jút',
        'provinceName' => 'Đắk Nông',
        'iframeMap' => "<iframe width=600 height=400 style=border:0 loading=lazy allowfullscreen src='https://maps.google.com/maps?q=12.591587,107.896341&amp;t=&amp;z=14&amp;ie=UTF8&amp;iwloc=B&amp;output=embed'></iframe>",
    ],
];

Calculate the expected delivery time

Accurate time will be delivered to guests

\GiaoHangNhanh::calculateExpectedDeliveryTime([
    'from_ward_code' => $from_ward_code,
    'from_district_id' => $from_district_id,
    'to_ward_code' => $to_ward_code,
    'to_district_id' => $to_district_id,
    'service_id' => $service_id,
]);
return [
    'leadtime' => 1729814399,
    'order_date' => 0,
];

Pick Shift

Automatic Get Pick shift in order

\GiaoHangNhanh::pickShift();
return [
    0 => [
        'id' => 2,
        'title' => 'Ca lấy 21-10-2024 (12h00 - 18h00)',
        'from_time' => 43200,
        'to_time' => 64800,
    ],
    1 => [
        'id' => 3,
        'title' => 'Ca lấy 22-10-2024 (7h00 - 12h00)',
        'from_time' => 111600,
        'to_time' => 129600,
    ],
    2 => [
        'id' => 4,
        'title' => 'Ca lấy 22-10-2024 (12h00 - 18h00)',
        'from_time' => 129600,
        'to_time' => 151200,
    ],
];

Calculate Fee

This API can help Shop/Merchant get the shipping fee and provide to buyer before create shipping order by input some information such as weight, height, length, width, to_district_id, to_ward_code, service_id

\GiaoHangNhanh::calculateFee([
    'service_id' => $service_id,
    'service_type_id' => $service_type_id,
    'insurance_value' => $insurance_value,
    'coupon' => $coupon,
    'cod_failed_amount' => $cod_failed_amount,
    'from_ward_code' => $from_ward_code,
    'from_district_id' => $from_district_id,
    'to_ward_code' => $to_ward_code,
    'to_district_id' => $to_district_id,
    'weight' => $weight,
    'length' => $length,
    'width' => $width,
    'height' => $height,
    'cod_value' => $cod_value,
    'items' => $items,
]);
return [
    'total' => 124610,
    'service_fee' => 118993,
    'insurance_fee' => 5617,
    'pick_station_fee' => 0,
    'coupon_value' => 0,
    'r2s_fee' => 0,
    'return_again' => 0,
    'document_return' => 0,
    'double_check' => 0,
    'cod_fee' => 0,
    'pick_remote_areas_fee' => 0,
    'deliver_remote_areas_fee' => 0,
    'cod_failed_fee' => 0,
];

Fee of Order Info

This API help you get all fee of a order

\GiaoHangNhanh::feeOrderInfo($order_code);
return [
    '_id' => 'Id (Hided)',
    'order_code' => 'Order code (Hided)',
    'detail' => [
        'main_service' => 93995,
        'insurance' => 11522,
        'cod_fee' => 0,
        'station_do' => 0,
        'station_pu' => 0,
        'return' => 0,
        'r2s' => 0,
        'return_again' => 0,
        'coupon' => 0,
        'document_return' => 0,
        'double_check' => 0,
        'double_check_deliver' => 0,
        'pick_remote_areas_fee' => 0,
        'deliver_remote_areas_fee' => 0,
        'pick_remote_areas_fee_return' => 0,
        'deliver_remote_areas_fee_return' => 0,
        'cod_failed_fee' => 0,
    ],
    'standard' => [
        'main_service' => 93995,
        'insurance' => 11522,
        'cod_fee' => 0,
        'station_do' => 0,
        'station_pu' => 0,
        'return' => 0,
        'r2s' => 0,
        'return_again' => 0,
        'coupon' => 0,
        'document_return' => 0,
        'double_check' => 0,
        'double_check_deliver' => 0,
        'pick_remote_areas_fee' => 0,
        'deliver_remote_areas_fee' => 0,
        'pick_remote_areas_fee_return' => 0,
        'deliver_remote_areas_fee_return' => 0,
        'cod_failed_fee' => 0,
    ],
    'payment' => [
        0 => [
            'diff' => [
                'main_service' => 93995,
                'insurance' => 11522,
                'cod_fee' => 0,
                'station_do' => 0,
                'station_pu' => 0,
                'return' => 0,
                'r2s' => 0,
                'return_again' => 0,
                'coupon' => 0,
                'document_return' => 0,
                'double_check' => 0,
                'double_check_deliver' => 0,
                'pick_remote_areas_fee' => 0,
                'deliver_remote_areas_fee' => 0,
                'pick_remote_areas_fee_return' => 0,
                'deliver_remote_areas_fee_return' => 0,
                'cod_failed_fee' => 0,
            ],
            'value' => 105517,
            'payment_type' => 2,
            'paid_date' => '0001-01-01T00:00:00Z',
            'created_date' => '2024-10-21T05:22:25.059Z',
        ],
    ],
    'cod_collect_date' => '0001-01-01T00:00:00Z',
    'transaction_id' => '44d2b24b-d3a3-4865-8a29-13697dc28a97',
    'created_ip' => '',
    'created_date' => '2024-10-21T05:22:25.059Z',
    'updated_ip' => '',
    'updated_client' => 0,
    'updated_employee' => 0,
    'updated_source' => '',
    'updated_date' => '2024-10-21T05:22:25.059Z',
];

Get Service

Use to get list of available services from district pick up items and to district drop off items (Full information)

\GiaoHangNhanh::getService([
    'from_district' => $from_district,
    'to_district' => $to_district,
]);
return [
    0 => [
        'service_id' => 53323,
        'short_name' => 'Hàng nhẹ',
        'service_type_id' => 2,
        'config_fee_id' => '',
        'extra_cost_id' => '',
        'standard_config_fee_id' => '',
        'standard_extra_cost_id' => '',
        'ecom_config_fee_id' => 684,
        'ecom_extra_cost_id' => 103,
        'ecom_standard_config_fee_id' => 684,
        'ecom_standard_extra_cost_id' => 103,
    ],
    1 => [
        'service_id' => 100039,
        'short_name' => 'Hàng nặng',
        'service_type_id' => 5,
        'config_fee_id' => '66c59e887e9ffb387092daa8',
        'extra_cost_id' => '65dedfd6b5bd2050b45c0ddf',
        'standard_config_fee_id' => '66c59e887e9ffb387092daa8',
        'standard_extra_cost_id' => '65dedfd6b5bd2050b45c0ddf',
        'ecom_config_fee_id' => 0,
        'ecom_extra_cost_id' => 0,
        'ecom_standard_config_fee_id' => 0,
        'ecom_standard_extra_cost_id' => 0,
    ],
];

Create Store

Use to create new Store. Each account can have many Store and each Store is a place to help GHN know where to pick up items

\GiaoHangNhanh::createStore([
    'ward_code' => $ward_code,
    'district_id' => $district_id,
    'name' => $name,
    'phone' => $phone,
    'address' => $address,
]);
return 194780;

Get Store

Get the current Store of logged in client. One client can have many pick up addresses. Each address is a Store

\GiaoHangNhanh::getStore([
    'clientphone' => $clientphone,
    'offset' => $offset,
    'limit' => $limit,
]);
return [
    'last_offset' => 5980924,
    'shops' => [
        0 => [
            '_id' => 5353886,
            'name' => 'Store Name (Hided)',
            'phone' => 'Store Phone (Hided)',
            'address' => 'Store Address (Hided)',
            'ward_code' => 'Store Ward Code (Hided)',
            'district_id' => 1490,
            'client_id' => 164936,
            'bank_account_id' => 0,
            'status' => 1,
            'location' => [],
            'version_no' => '8d4ade30-e9d2-4157-a1da-a5727d533272',
            'is_created_chat_channel' => false,
            'updated_ip' => '171.224.180.113',
            'updated_employee' => 0,
            'updated_client' => 164936,
            'updated_source' => 'shiip',
            'updated_date' => '2024-09-28T15:09:56.01Z',
            'created_ip' => '171.224.180.113',
            'created_employee' => 0,
            'created_client' => 164936,
            'created_source' => 'shiip',
            'created_date' => '2024-09-28T15:09:56.01Z',
        ],
    ],
];

Get Province

Get GHN ward/province data. This API provides province to create shipping order

\GiaoHangNhanh::getProvince();
return [
    0 => [
        'ProvinceID' => 269,
        'ProvinceName' => 'Lào Cai',
        'CountryID' => 1,
        'Code' => '20',
        'NameExtension' => [
            0 => 'Lào Cai',
            1 => 'Tỉnh Lào Cai',
            2 => 'T.Lào Cai',
            3 => 'T Lào Cai',
            4 => 'laocai',
        ],
        'IsEnable' => 1,
        'RegionID' => 6,
        'RegionCPN' => 5,
        'UpdatedBy' => 1718600,
        'CreatedAt' => '2019-12-05 15:41:26.891384 +0700 +07 m=+0.010448463',
        'UpdatedAt' => '2019-12-05 15:41:26.891384 +0700 +07 m=+0.010449016',
        'AreaID' => 1,
        'CanUpdateCOD' => false,
        'Status' => 1,
        'UpdatedIP' => '103.191.145.200',
        'UpdatedEmployee' => 209749,
        'UpdatedSource' => 'internal',
        'UpdatedDate' => '2024-06-19T10:40:21.091Z',
    ],
];

Get District

Get GHN district/province data. This data is used to reference the District ID to create shipping order

\GiaoHangNhanh::getDistrict($province_id);
return [
    0 => [
        'DistrictID' => 1969,
        'ProvinceID' => 249,
        'DistrictName' => 'Huyện Lương Tài',
        'Code' => '1908',
        'Type' => 3,
        'SupportType' => 3,
        'NameExtension' => [
            0 => 'Huyện Lương Tài',
            1 => 'H.Lương Tài',
            2 => 'H Lương Tài',
            3 => 'Lương Tài',
            4 => 'Luong Tai',
            5 => 'Huyen Luong Tai',
            6 => 'luongtai',
        ],
        'IsEnable' => 1,
        'UpdatedBy' => 1718600,
        'CreatedAt' => '2019-12-05 15:53:32.432534 +0700 +07 m=+0.016480079',
        'UpdatedAt' => '2020-09-29 13:42:56.357876 +0700 +07 m=+28.860032501',
        'CanUpdateCOD' => false,
        'Status' => 1,
        'PickType' => 0,
        'DeliverType' => 0,
        'WhiteListClient' => [
            'From' => [],
            'To' => [],
            'Return' => [],
        ],
        'WhiteListDistrict' => [
            'From' => null,
            'To' => null,
        ],
        'ReasonCode' => '',
        'ReasonMessage' => '',
        'OnDates' => null,
        'UpdatedEmployee' => 3006735,
        'UpdatedDate' => '2023-10-06T07:41:02.399Z',
    ],
];

Get Ward

Get GHN ward/province data. This API provides Ward Code to create shipping order

\GiaoHangNhanh::getWard($district_id);
return [
    0 => [
        'WardCode' => '800082',
        'DistrictID' => 3311,
        'WardName' => 'Xã Điềm He',
        'NameExtension' => [
            0 => 'Xã Điềm He',
            1 => 'Diem He',
            2 => 'Xa Diem He',
            3 => 'diemhe',
        ],
        'IsEnable' => 1,
        'CanUpdateCOD' => false,
        'UpdatedBy' => 1718600,
        'CreatedAt' => '2019-12-05 16:02:20.414338 +0700 +07 m=+0.050675313',
        'UpdatedAt' => '2020-09-29 13:50:14.90403 +0700 +07 m=+39.570093743',
        'SupportType' => 3,
        'PickType' => 3,
        'DeliverType' => 3,
        'WhiteListClient' => [
            'From' => [],
            'To' => [],
            'Return' => [],
        ],
        'WhiteListWard' => [
            'From' => null,
            'To' => null,
        ],
        'Status' => 1,
        'ReasonCode' => '',
        'ReasonMessage' => '',
        'OnDates' => null,
        'UpdatedEmployee' => 3006735,
        'UpdatedDate' => '2023-10-06T07:41:04.182Z',
    ],
];

Create Ticket

Create Ticket then need support your order

\GiaoHangNhanh::createTicket([
    'order_code' => $order_code,
    'category' => $category,
    'attachments' => $attachments,
    'description' => $description,
    'c_email' => $c_email,
]);
return [
    'attachments' => [],
    'client_id' => 'Client Id (Hided)',
    'conversations' => null,
    'created_at' => '2024-10-21T06:26:12Z',
    'created_by' => 2043022450559,
    'description' => "Run Test (Don't reply this ticket)",
    'id' => 26262246,
    'order_code' => 'Order code (Hided)',
    'status' => 'Đang xử lý',
    'status_id' => 1,
    'type' => 'Thay đổi thông tin',
    'updated_at' => '2024-10-21T06:26:12Z',
];

Create Feedback of Ticket

Reply Feedback of Ticket

\GiaoHangNhanh::createFeedbackTicket([
    'ticket_id' => $ticket_id,
    'attachments' => $attachments,
    'description' => $description,
]);
return [
    'body' => "<div>Run Test (Don't reply this ticket)</div>",
    'created_at' => '2024-10-21T06:34:52Z',
    'from_email' => '"Email Support Khách hàng GHN" <cskh@ghn.vn>',
    'updated_at' => '2024-10-21T06:34:52Z',
    'user_id' => 2043022450559,
];

Get Ticket List

Get all ticket to created

\GiaoHangNhanh::getTicketList([
    'offset' => $offset,
    'limit' => $limit,
]);
return [
    0 => [
        'attachments' => [],
        'c_email' => 'Client Email (Hided)',
        'c_name' => 'Client Name (Hided)',
        'c_phone' => 'Client Phone (Hided)',
        'client_id' => 'Client Id (Hided)',
        'conversations' => [],
        'created_at' => '2024-10-21T06:26:12Z',
        'created_by' => 2043022450559,
        'description' => "Run Test (Don't reply this ticket)",
        'id' => 26262246,
        'order_code' => 'Order code (Hided)',
        'status' => 'Đang xử lý',
        'status_id' => 1,
        'type' => 'Thay đổi thông tin',
        'updated_at' => '2024-10-21T06:26:13Z',
    ],
];

Get Ticket

Get all ticket to created

\GiaoHangNhanh::getTicket($ticket_id);
return [
    'attachments' => [],
    'c_email' => 'Client Email (Hided)',
    'c_name' => 'Client Name (Hided)',
    'c_phone' => 'Client Phone (Hided)',
    'client_id' => 'Client Id (Hided)',
    'conversations' => [],
    'created_at' => '2024-10-21T06:26:12Z',
    'created_by' => 2043022450559,
    'description' => "Run Test (Don't reply this ticket)",
    'id' => 26262246,
    'order_code' => 'Order code (Hided)',
    'status' => 'Đang xử lý',
    'status_id' => 1,
    'type' => 'Thay đổi thông tin',
    'updated_at' => '2024-10-21T06:26:13Z',
];

Get Tracking Url

\GiaoHangNhanh::getTrackingUrl($order_code);
return 'https://donhang.ghn.vn?order_code=order_code';

Fail Code - Reason new

\TriNguyenDuc\GiaoHangNhanh\Enums\OrderReason::values();
return [
    // Lấy thất bại
    'GHN-PFA1A0' => 'Lấy không thành công: Người gửi hẹn lại ngày lấy hàng',
    'GHN-PFA2A2' => 'Lấy không thành công: Thông tin lấy hàng sai (địa chỉ / SĐT)',
    'GHN-PFA2A1' => 'Lấy không thành công: Thuê bao không liên lạc được / Máy bận',
    'GHN-PFA2A3' => 'Lấy không thành công: Người gửi không nghe máy',
    'GHN-PFA1A1' => 'Lấy không thành công: Người gửi muốn gửi hàng tại bưu cục',
    'GHN-PCB0B2' => 'Lấy không thành công: Hàng vi phạm quy định khối lượng, kích thước',
    'GHN-PFA4A1' => 'Lấy không thành công: Hàng vi phạm quy cách đóng gói',
    'GHN-PCB0B1' => 'Lấy không thành công: Người gửi không muốn gửi hàng nữa',
    'GHN-PFA4A2' => 'Lấy không thành công: Hàng hóa GHN không vận chuyển',
    'GHN-PFA3A2' => 'Lấy không thành công: Nhân viên gặp sự cố',
    // Giao thất bại
    'GHN-DFC1A0' => 'Giao không thành công: Người nhận hẹn lại ngày giao',
    'GHN-DFC1A2' => 'Giao không thành công: Không liên lạc được người nhận / Chặn số',
    'GHN-DFC1A4' => 'Giao không thành công: Người nhận không nghe máy',
    'GHN-DCD0A1' => 'Giao không thành công: Sai thông tin người nhận (địa chỉ / SĐT)',
    'GHN-DFC1A1' => 'Giao không thành công: Người nhận đổi địa chỉ giao hàng',
    'GHN-DFC1A7' => 'Giao không thành công: Người nhận từ chối nhận do không cho xem / thử hàng',
    'GHN-DCD0A6' => 'Giao không thành công: Người nhận từ chối nhận do sai sản phẩm',
    'GHN-DCD0A7' => 'Giao không thành công: Người nhận từ chối nhận do sai COD',
    'GHN-DCD0A5' => 'Giao không thành công: Người nhận từ chối nhận do hàng hư hỏng',
    'GHN-DCD1A5' => 'Giao không thành công: Người nhận từ chối nhận do không có tiền',
    'GHN-DCD0A8' => 'Giao không thành công: Người nhận đổi ý không mua nữa',
    'GHN-DCD1A1' => 'Giao không thành công: Người nhận báo không đặt hàng',
    'GHN-DFC1A6' => 'Giao không thành công: Nhân viên gặp sự cố',
    'GHN-DCD1A3' => 'Giao không thành công: Hàng suy suyển, bể vỡ trong quá trình vận chuyển',
    // Trả thất bại
    'GHN-RFE0A0' => 'Trả không thành công: Người gửi hẹn lại ngày trả hàng',
    'GHN-RFE0A1' => 'Trả không thành công: Người gửi đổi địa chỉ trả hàng',
    'GHN-RFE0A6' => 'Trả không thành công: Người gửi không nghe máy',
    'GHN-RFE0A3' => 'Trả không thành công: Người gửi từ chối nhận do sai sản phẩm',
    'GHN-RFE0A4' => 'Trả không thành công: Người gửi từ chối nhận do hàng hư hỏng.',
    'GHN-RFE0A5' => 'Trả không thành công: Nhân viên gặp sự cố',
];

List Of Shipping Status

\TriNguyenDuc\GiaoHangNhanh\Enums\OrderStatus::values();
return [
    'READY_TO_PICK' => 'Chờ lấy hàng',
    'PICKING' => 'Đang lấy hàng',
    'MONEY_COLLECT_PICKING' => 'Đang tương tác với người gửi',
    'PICKED' => 'Lấy hàng thành công',
    'STORING' => 'Nhập kho',
    'TRANSPORTING' => 'Đang trung chuyển',
    'SORTING' => 'Đang phân loại',
    'DELIVERING' => 'Đang giao hàng',
    'DELIVERED' => 'Giao hàng thành công',
    'MONEY_COLLECT_DELIVERING' => 'Đang tương tác với người nhận',
    'DELIVERY_FAIL' => 'Giao hàng không thành công',
    'WAITING_TO_RETURN' => 'Chờ xác nhận giao lại',
    'RETURN' => 'Chuyển hoàn',
    'RETURN_TRANSPORTING' => 'Đang trung chuyển hàng hoàn',
    'RETURN_SORTING' => 'Đang phân loại hàng hoàn',
    'RETURNING' => 'Đang hoàn hàng',
    'RETURN_FAIL' => 'Hoàn hàng không thành công',
    'RETURNED' => 'Hoàn hàng thành công',
    'CANCEL' => 'Đơn huỷ',
    'EXCEPTION' => 'Hàng ngoại lệ',
    'LOST' => 'Hàng thất lạc',
    'DAMAGE' => 'Hàng hư hỏng',
];

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.