Skip to main content
Version: 3.0.0

Get List Of Service

Get a list of services available based on each province or via geolocation

curl --location 'https://partner-apistg.ahamove.com/v3/services?city_id=SGN&delivery_type=INSTANT' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \

HTTP Request

GET https://partner-apistg.ahamove.com/v3/services?city_id=SGN

Headers

ParameterValueRequiredDescription
Content-Typeapplication/jsonYes
AuthorizationBearer <token>YesToken of the user account

Query Parameters

ParameterTypeRequiredDescription
latStringYesLatitude, Optional if city_id is provided
lngStringYesLongitude, Optional if city_id is provided
city_idStringYesCity Id, Required if lat/lng is not provided
delivery_typeStringNoType of delivery. INSTANT for public services, TRUCK for truck services

Response

JSON response example:

[
{
"_id": "SGN-BIKE",
"advance_broadcast_distance": 2000,
"auto_assign": false,
"auto_assign_distance": 1000,
"city_id": "SGN",
"cod": 10000000,
"commission_type": "PERCENTAGE",
"commission_value": 0.212,
"currency": "VND",
"delivery_type": "INSTANT",
"description_en_us": "Giao hàng nội thành trong 1 giờ",
"description_vi_vn": "Lấy hàng ngay, giao hỏa tốc",
"distance_fee": "(25000 if x <= 2 else 19636 if x <= 3 else 19636 + (x - 3) * 5400)",
...

# List of special requests
"requests": [
{
"_id": "SGN-BIKE-TIP",
"description_en_us": "This will show your support or compliment to the driver, especially in rush hours, hand to hand delivery, bad weather. Also, this feature will prioritize your request in peak time.",
"description_vi_vn": "Hãy chọn dịch vụ này nếu bạn muốn hỗ trợ tài xế trong giờ cao điểm, khi cần giao hàng lên lầu, nơi phải tốn phí giữ xe, khi thời tiết khó khăn, hoặc đơn giản là muốn thưởng thêm cho tài xế. Ngoài ra, tính năng này sẽ giúp cho đơn hàng của bạn được ưu tiên hơn trong thời gian cao điểm.",
"device_types": [],
"enable": true,
"group_id": "TIP",
"max_input": 6,
"name": "Hỗ trợ tài xế (PER_UNIT)",
"price": 5000,
}
],
}
]

Status-Code: 200 OK

Errors

CodeTextDescription
404CITY_NOT_FOUND- City not found
- Unable to determine city from latitude/longitude
406INVALID_DELIVERY_TYPEInvalid delivery type
500INTERNAL_SERVER_ERRORWe had a problem with our server. Try again later
503SERVICE_UNAVAILABLEWe're temporarily offline for maintenance. Please try again later