Estimate order fee with group services

Estimate order fee

Overview

This api is used to estimate order fee from multiple services for partner

Headers

Key	Value	Description
Content-Type	application/json
Authorization	Bearer {token}	Partner token

JSON Body Format

* Service object

Key	Type	Required	Description
_id	string	true	Service ID
requests	array	true	List of special request object or []

* Stop point object

Key	Type	Required	Description
address	string	true	Text address
lat	float	true	Latitude
lng	float	true	Longitude
name	string	true	Name of receiver or sender
mobile	string	true	Mobile phone of receiver or sender
cod	int	false	COD amount in this stop point
formatted_address	string	false	Formatted text address
short_address	string	false	Short address text
address_code	string	false	Address code
remarks	string	false	A note for supplier
item_value	int	false	Item's value

* Special request object

Key	Type	Required	Description
_id	string	true	ID of the special request (e.g SGN-BIKE-TIPS)
num	int	false	Number of unit special request if it's PER_UNIT type
tier_code	string	false	Code of selected tier if it's TIER type
option_code	string	false	Code of selected option (e.g option in SGN-BIKE-FRAGILE
option_detail	string	false	Option detail of selected option

* Item object

Key	Type	Required	Description
_id	int	true	Item ID
store_id	int	true	Store ID
name	string	true	Item name
price	int	true	Item price
num	int	true	Number of item

* Body

Key	Type	Required	Description
path	array	true	List of stop point object
payment_method	string	true	Payment method to pay order
services	array	true	List of service object
order_time	float	false	Time when user want to broadcast order to supplier
promo_code	string	false	Promo code to apply for discount
idle_until	float	false	Time when user want to broadcast order to supplier
items	array	false	List of items to log in orders

Package detail

Key	Type	Required	Description
weight	float	true	Item weight (kg)
length	float	false	Item length (m)
width	float	false	Item witdth (m)
height	float	false	Item height (m)
description	description	false	Item description

Response

* HTTP Code: 200
* JSON body format
* Service which can be estimated fee will have value in field data, field error is null. Otherwise, data is null and error is not null

[
  {
    "service_id": "SGN-BIKE",
    "data": {
      "distance": 11.6298,
      "duration": 3166,
      "user_main_account": 0,
      "user_bonus_account": 0,
      "currency": "VND",
      "total_pay": 72000,
      "polyline_points": "qmv`Agy_jSpFeBy@wB^y@{AqE`HqBuA}CZgBp@cb@j@iAYo@~Ksi@r@MJq@sBaAaNiVy@qDTaAsJaJfDoCkAsCfAk@q]_k@gn@ik@aBjBeCwBdCvBaG|G~DtDhNfCd`@f]hPpWwB~EjZxXU`AVtBxAdCsAdDB`AjOnNRbA_DlOgGdYo@h@b@rAm@j]MtDe@`AhPd^",
      "polylines": "qmv`Agy_jSpFeBy@wB^y@{AqE`HqBuA}CZgBp@cb@j@iAYo@~Ksi@r@MJq@sBaAaNiVy@qDTaAsJaJfDoCkAsCfAk@q]_k@gn@ik@aBjBeCwBdCvBaG|G~DtDhNfCd`@f]hPpWwB~EjZxXU`AVtBxAdCsAdDB`AjOnNRbA_DlOgGdYo@h@b@rAm@j]MtDe@`AhPd^",
      "total_balance": 0,
      "is_post_paid": false,
      "is_child_account": false,
      "online_pay": 0,
      "payment_method": "CASH",
      "distance_fee": 62000,
      "request_fee": 5000,
      "stop_fee": 5000,
      "vat_fee": 0,
      "discount": 0,
      "total_fee": 72000,
      "item_fee": 0,
      "item_vat_fee": 0,
      "item_discount": 0,
      "cod_commission_fee": 0,
      "requests": [
        {
          "_id": "SGN-BIKE-TIP",
          "num": 1,
          "price": 5000
        }
      ],
      "stoppoint_price": 5000,
      "special_request_price": 5000,
      "vat": 0,
      "distance_price": 62000,
      "voucher_discount": 0,
      "subtotal_price": 72000,
      "total_price": 72000,
      "surge_rate": 0
    },
    "error": null
  },
  {
    "service_id": "SGN-POOL",
    "data": null,
    "error": {
      "http_code": 406,
      "code": "INVALID_MAX_COD",
      "title": "COD is not valid",
      "description": "Rất tiếc, dịch vụ này chỉ hỗ trợ tổng COD tối đa đ{{ data.max_cod }}",
      "internal": ""
    }
  }
]

Error Responses

This explained the error field in each element of the response body

HTTP Status	Code	Meaning
406	INVALID_FUTURE_ORDER_TIME	Advanced booking time is not valid (e.g more than 1 month from now)
406	NOT_SUPPORT_ADVANCE_BOOKING	Service does not support advanced booking
406	SERVICE_NOT_VALID_AT_PICKUP	Service does not available at the pickup point
406	INVALID_PICKUP_AREA	Service does not available in this area
406	INVALID_DELIVERY_AREA	Service does not support delivery in this area
400	MISSING_PATH_INFO	Path does not contain enough stop point
406	INVALID_MAX_DISTANCE	Distance violate max_distance configured in service
406	INVALID_MAX_STOP_POINT	Number of stop point in path exceed max_stop_point of service
406	INVALID_MIN_STOP_POINT	Number of stop point in path is less than min_stop_point of service

This explained the error for entirely request

HTTP Status	Code	Meaning
400	BAD_REQUEST	Request contains invalid data

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "order_time": 0,
    "path": [
        {
            "lat": 10.76975346,
            "lng": 106.6636615,
            "address": "7/28 Thành Thái, Phường 14, Quận 10, Thành phố Hồ Chí Minh",
            "short_address": "Thành Thái, Quận 10",
            "name": "Lan",
            "mobile": "84944309348",
            "remarks": "Đến nơi lấy hàng đọc mã đơn để nhận hàng"
        },
        {
            "lat": 10.8018493,
            "lng": 106.714466,
            "address": "475A Điện Biên Phủ, Phường 25, Bình Thạnh, Thành phố Hồ Chí Minh",
            "short_address": "Đại Học Hutech, Quận Bình Thạnh, Hồ Chí Minh",
            "name": "Anh",
            "mobile": "0912345678",
            "cod": 100000,
            "item_value": 250000,
            "tracking_number": "ABCD1234",
            "remarks": "Gọi điện trước khi giao. Giao hàng cẩn thận"
        }
    ],
    "group_services": [
        {
            "_id": "BIKE",
            "group_requests": [
                {
                    "_id": "TIP",
                    "num": 1
                },
                {
                    "_id": "BULKY",
                    "tier_code": "TIER_2"
                }
            ]
        },
        {
            "_id": "ECO",
            "group_requests": []
        },
        {
            "_id": "TRUCK-2000",
            "group_requests": []
        },
        {
            "_id": "VNM-PARTNER-AHAMOVE",
            "group_requests": [
                {
                    "_id": "DONG-KIEM",
                    "num": 1
                }
            ]
        }
    ],
    "payment_method": "CASH",
    "remarks": "Ghi chú đơn hàng",
    "promo_code" : "AHMKM",
    "items": [
        {
            "_id": "TG",
            "num": 1,
            "name": "Tủ gỗ nhỏ",
            "price": 450000
        },
        {
            "_id": "GDB",
            "num": 2,
            "name": "Gương để bàn",
            "price": 120000
        }
    ],
    "package_detail": [
        {
            "weight": 10,
            "length": 1.2,
            "width": 0.8,
            "height": 2.0,
            "description": "Nội thất"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://partner-apistg.ahamove.com//v3/orders/estimates' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "order_time": 0,
    "path": [
        {
            "lat": 10.76975346,
            "lng": 106.6636615,
            "address": "7/28 Thành Thái, Phường 14, Quận 10, Thành phố Hồ Chí Minh",
            "short_address": "Thành Thái, Quận 10",
            "name": "Lan",
            "mobile": "84944309348",
            "remarks": "Đến nơi lấy hàng đọc mã đơn để nhận hàng"
        },
        {
            "lat": 10.8018493,
            "lng": 106.714466,
            "address": "475A Điện Biên Phủ, Phường 25, Bình Thạnh, Thành phố Hồ Chí Minh",
            "short_address": "Đại Học Hutech, Quận Bình Thạnh, Hồ Chí Minh",
            "name": "Anh",
            "mobile": "0912345678",
            "cod": 100000,
            "item_value": 250000,
            "tracking_number": "ABCD1234",
            "remarks": "Gọi điện trước khi giao. Giao hàng cẩn thận"
        }
    ],
    "group_services": [
        {
            "_id": "BIKE",
            "group_requests": [
                {
                    "_id": "TIP",
                    "num": 1
                },
                {
                    "_id": "BULKY",
                    "tier_code": "TIER_2"
                }
            ]
        },
        {
            "_id": "ECO",
            "group_requests": []
        },
        {
            "_id": "TRUCK-2000",
            "group_requests": []
        },
        {
            "_id": "VNM-PARTNER-AHAMOVE",
            "group_requests": [
                {
                    "_id": "DONG-KIEM",
                    "num": 1
                }
            ]
        }
    ],
    "payment_method": "CASH",
    "remarks": "Ghi chú đơn hàng",
    "promo_code" : "AHMKM",
    "items": [
        {
            "_id": "TG",
            "num": 1,
            "name": "Tủ gỗ nhỏ",
            "price": 450000
        },
        {
            "_id": "GDB",
            "num": 2,
            "name": "Gương để bàn",
            "price": 120000
        }
    ],
    "package_detail": [
        {
            "weight": 10,
            "length": 1.2,
            "width": 0.8,
            "height": 2.0,
            "description": "Nội thất"
        }
    ]
}'

Estimate order fee with group services