Create Order

cURL
JavaScript

curl --request POST \
    --url https://apistg.ahamove.com/v1/order/create \
    --header 'Cache-Control: no-cache' \
    --header 'accept: application/json' \
    --header 'content-type: application/x-www-form-urlencoded' \
    --data-urlencode 'service_id=SGN-BIKE' \
    --data-urlencode 'payment_method=CASH' \
    --data-urlencode 'promo_code=KHUYENMAI' \
	--data-urlencode 'remarks=This is note for order' \
    --data-urlencode 'order_time=0' \
    --data-urlencode 'requests=[{"_id":"SGN-BIKE-TIP","num":2}]' \
    --data-urlencode 'path=[{"lat":10.7692105,"lng":106.6637935,"address":"725 Hẻm số 7 Thành Thái, Phường 14, Quận 10, Hồ Chí Minh, Việt Nam","short_address":"Quận 10","name":"nmbmb","mobile":"84xxxxxxxxx"},{"lat":10.7828887,"lng":106.704898,"address":"Miss Ao Dai Building, 21 Nguyễn Trung Ngạn, Bến Nghé, Quận 1, Hồ Chí Minh, Vietnam","name":"Bao","mobile":"84xxxxxxxxx","remarks":"call me","cod":85000,"tracking_number":"1234"}]' \
    --data-urlencode 'items=[{"_id": "TS","num": 2,"name": "Sua tuoi","price": 15000},{"_id": "ST","num": 2,"name": "Sinh to","price": 30000}]' \
	--data-urlencode 'token=<TOKEN_STG>'

var myHeaders = new Headers();
myHeaders.append('accept', 'application/json');
myHeaders.append('content-type', 'application/x-www-form-urlencoded');

var urlencoded = new URLSearchParams();
urlencoded.append('service_id', 'SGN-BIKE');
urlencoded.append('payment_method', 'CASH');
urlencoded.append('promo_code', 'KHUYENMAI');
urlencoded.append('remarks', 'This is note for order');
urlencoded.append('order_time', '0');
urlencoded.append('requests', '[{"_id":"SGN-BIKE-TIP","num":2}]');
urlencoded.append(
	'path',
	'[{"lat":10.7692105,"lng":106.6637935,"address":"725 Hẻm số 7 Thành Thái, Phường 14, Quận 10, Hồ Chí Minh, Việt Nam","short_address":"Quận 10","name":"nmbmb","mobile":"84xxxxxxxxx"},{"lat":10.7828887,"lng":106.704898,"address":"Miss Ao Dai Building, 21 Nguyễn Trung Ngạn, Bến Nghé, Quận 1, Hồ Chí Minh, Vietnam","name":"Bao","mobile":"84xxxxxxxxx","remarks":"call me","cod":85000,"tracking_number":"1234"}]'
);
urlencoded.append("items", "[{"_id": "TS","num": 2,"name": "Sua tuoi","price": 15000},{"_id": "ST","num": 2,"name": "Sinh to","price": 30000}]");
urlencoded.append('token', '<TOKEN_STG>');
urlencoded.append('conversion_data', '');

var requestOptions = {
	method: 'POST',
	headers: myHeaders,
	body: urlencoded,
	redirect: 'follow',
};

fetch('https://apistg.ahamove.com/v1/order/create', requestOptions)
	.then((response) => response.text())
	.then((result) => console.log(result))
	.catch((error) => console.log('error', error));

Create a new order by user (support both GET/POST method)

HTTP Request

POST https://apistg.ahamove.com/v1/order/create (x-wwww-form-urlencoded)

GET https://apistg.ahamove.com/v1/order/create

Parameters

# Parameters
{
    "order_time": 0,
    "path": [
        {
            "lat": 10.7692105,
            "lng": 106.6637935,
            "address": "725 Hẻm số 7 Thành Thái, Phường 14, Quận 10, Hồ Chí Minh, Việt Nam",
            "short_address": "Quận 10",
            "name": "nmbmb",
            "mobile":"84xxxxxxxxx"
        },
        {
            "lat": 10.7828887,
            "lng": 106.704898,
            "address": "Miss Ao Dai Building, 21 Nguyễn Trung Ngạn, Bến Nghé, Quận 1, Hồ Chí Minh, Vietnam",
            "name": "Bao",
            "mobile":"84xxxxxxxxx",
            "remarks": "call me",
			"cod": 85000,
			"tracking_number": "1234"
        }
    ],
    "service_id": "SGN-BIKE",
	"remarks":"This is note for order",
    "requests": [
		{
        "_id": "SGN-BIKE-TIP",
        "num": 2
        }
	],
    "images": [],
    "promo_code": "KHUYENMAI",
    "remarks": "Call me when arrived",
    "payment_method": "CASH",
    "items": [
        {
            "_id": "TS",
            "num": 2,
            "name": "Sua tuoi",
            "price": 15000
        },
        {
            "_id": "ST",
            "num": 2,
            "name": "Sinh to lua mach",
            "price": 30000
        }
    ]
}

Parameter	Type	Required	Description
token	String	Yes	The user Token.
order_time	Number (Unix timestamp)	Yes	The pickup time. Set 0 to pickup ASAP.
path	String	Yes	At least 2 pairs (described in more detail below).
service_id	String	Yes	Ahamove Service ID (SGN-BIKE, SGN-POOL, etc.).
requests	Array	Yes	JSONArray representing Special Requests.
payment_method	String	Yes	Payment method chosen by user (BALANCE or CASH/CASH_BY_RECIPIENT)- Require on production after December 1st, 2019.
images	Array	No	JSONArray representing image urls.
promo_code	String	No	Promo code to discount shipping fee.
remarks	String	No	Remarks.
idle_until	Number (Unix timestamp)	Yes	The broadcast time. Set `idle_until=order_time` if order_time > 0. Optional if `order_time` is 0.
items	Array	No	JSONArray representing items (for Food Partners)
type	String	No	Order type, for eg: warehouse, etc … Treat as normal flow incase type is not specified
need_optimize_route	Boolean	No	In case, if partner need Ahamove to optimize route (1 pickup, > 2 drop off points)

Path

Representing From path[0] and multiple Tos path[x], x > 0

Parameter	Type	Required	Description
address	String	Yes	Address of the location.
lat	Number	Yes	Latitude of the location (Optional but highly recommended).
lng	Number	Yes	Longitude of the location (Optional but highly recommended).
name	String	Yes	Recipient's name. Optional if is `path[0]`.
mobile	String	Yes	Recipient's mobile number. Optional if is `path[0]`.
tracking_number	String	No	Tracking number for the package (Partner's internal order id, not required but Ahamove highly recommended having this field in `path[x]`).
remarks	String	No	Note to supplier, for multiple delivery points.
cod	Number	No	COD amount (Cash on delivery)
require_pod	Boolean	No	If true, supplier will be required proof of delivery before complete the transaction
building	String	No	Building name for delivery to door
apt_number	String	No	Apartment, Suite or Floor number for delivery to door

lat and lng is not required but address field in parameters needs to have correct information as shown in the format below

user_free_text_input, ward, province/district, city

Ex: 135 Nam Kỳ Khởi Nghĩa, Bến Thành, Quận 1, Hồ Chí Minh

Response

JSON response example: // disable prettier format

{
	"order_id": "USAGND",
	"status": "ASSIGNING",
	"shared_link": "https://cloudstg.ahamove.com/share-order/USAGND/84909055578",
	"order": {
		"_id": "USAGND",
		"currency": "VND",
		"user_main_account": 0,
		"user_bonus_account": 0,
		"total_pay": 33000,
		"distance": 1.02,
		"duration": 268,
		"distance_fee": 23000,
		"request_fee": 10000,
		"stop_fee": 0,
		"vat_fee": 0,
		"discount": 0,
		"path": [
			{
				"address": "Nhà Thờ Đức Bà, Vietnam",
				"lat": 10.7797855,
				"lng": 106.6990189
			},
			{
				"address": "Chợ Bến Thành, Vietnam",
				"lat": 10.7725451,
				"lng": 106.6980413
			}
		],
		"from_location": {
			"type": "Point",
			"coordinates": [106.6990189, 10.7797855]
		},
		"requests": [
			{
				"_id": "SGN-BIKE-TIP",
				"num": 2
			}
		],
		"items": [],
		"total_fee": 33000,
		"remarks": "This is note for order",
		"app": "Ahamove",
		"service_id": "SGN-BIKE",
		"city_id": "SGN",
		"user_id": "84xxxxxxxxx",
		"user_name": "TEST CREATE AN ORDER",
		"user_imei": null,
		"create_time": 1565577713.2757928,
		"order_time": 1565577713.2757928,
		"index": 12,
		"status": "ASSIGNING",
		"partner": "TESTPARTNER",
		"polylines": "ukx`A}rfjS~CuDhHnGlBnA|DoEdFcB|BhBxBtDzBmA",
		"online_pay": 0,
		"notify_package_return": true,
		"uniform_user_feedback": 2,
		"pending_period": 100,
		"stoppoint_price": 0,
		"special_request_price": 10000,
		"vat": 0,
		"distance_price": 23000,
		"voucher_discount": 0,
		"subtotal_price": 33000,
		"total_price": 33000
	}
}

Status-Code: 200 OK

Errors

Code	Text	Description
`404`	`Not Found`	- Token not found (Token has expired. When a new token is created, the old token has expired) - Path not found - Service not found
`406`	`Not Acceptable`	- Booking time not valid - Address not valid - Request not valid - Distance not valid - Invalid pickup area - Invalid delivery area - Concurrent order not allowed (If partner not in token) - Large COD not allowed for first time user - Post paid not set for partner - Not supported payment method - Not enough credit - User’s phone number associated with - Token has been used for a partner - Child order status not valid (When creating parent order) - Parent order existed for #ABCXYZ (When creating a parent order but child orders already had a parent) - Idle until not valid (When client sent idle_until < current_time) - COD is not valid ( When total COD exceeds the maximum value which was configured in service) - Number of stop points are not valid
`408`	`Request timeout`	Google Distance API does not return results in 10 seconds.
`409`	`Conflict`	- New order not allow (Not allow 2 consecutive orders in 1 minute) - Tracking number duplicated (Not allow to create duplicated tracking number within 60s)
`500`	`Internal Server Error`	We had a problem with our server. Try again later.
`503`	`Service Unavailable`	We're temporarily offline for maintenance. Please try again later.

Create Order

HTTP Request​

Parameters​

Path​

Response​

Errors​

HTTP Request

Parameters

Path

Response

Errors