Introduction

Base URL

https://rest.lalamove.com

https://rest.br.lalamove.com

https://sandbox-rest.lalamove.com

Lalamove API allows you to integrate our delivery services into your business workflow.

Lalamove provides a collection of essential, lightweight and flexible endpoints allowing you to automate your fulfilment logistics workflow quickly and easily.

It normally takes a developer a week or two to complete an integration ready for our Go-Live Process.

Authentication

Lalamove API makes use of HMAC (SHA256) as the authentication mechanism.

You will be provided an api KEY, and a SECRET for generating a HMAC hash (also known as a SIGNATURE).

Sandbox & Production API keys

All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

Signature

Example in JavaScript

const SECRET = 'MCwCAQACBQDDym2lAgMBAAECBDHB';
const time = new Date().getTime().toString(); // => `1545880607433`

const method = 'POST';
const path = '/v2/quotations';
const body = JSON.stringify({...}); // => the whole body for '/v2/quotations'

const rawSignature = `${time}\r\n${method}\r\n${path}\r\n\r\n${body}`;
// => '1546222219293\r\nPOST\r\n/v2/quotations\r\n\r\n{\n \"scheduleAt\": \"2018-12-31T14:30:00.00Z\",\n \"serviceType\": \"MOTORCYCLE\",\n \"requesterContact\": { \"name\": \"Peter Pan\", \"phone\": \"232\" },\n \"stops\": [\n {\n \"location\": { \"lat\": \"-6.255431000000001\", \"lng\": \"106.60114290000001\" },\n \"addresses\": {\n \"en_ID\": {\n \"displayString\":\n \"Jl. Perum Dasana Indah No.SD 3/ 17-18, RT.3/RW.1, Bojong Nangka, Klp. Dua, Tangerang, Banten 15810, Indonesia\",\n \"country\": \"ID\"\n }\n }\n },\n {\n \"location\": { \"lat\": \"-6.404722800000001\", \"lng\": \"106.81902130000003\" },\n \"addresses\": {\n \"en_ID\": {\n \"displayString\": \"Jl. Kartini, Ruko No. 1E, Depok, Pancoran MAS, Kota Depok, Jawa Barat 16431, Indonesia\",\n \"country\": \"ID\"\n }\n }\n }\n ],\n \"deliveries\": [\n {\n \"toStop\": 1,\n \"toContact\": {\n \"name\": \"mm\",\n \"phone\": \"9999999\"\n }\n }\n ]\n}\n'

const SIGNATURE = CryptoJS.HmacSHA256(rawSignature, SECRET).toString();
// => '5133946c6a0ba25932cc18fa3aa1b5c3dfa2c7f99de0f8599b28c2da88ed9d42'

SIGNATURE = HmacSHA256ToHex(<TIMESTAMP>\r\n<HTTP_VERB>\r\n<PATH>\r\n\r\n<BODY>, <SECRET>)

SIGNATURE is in lowercase hex (base 16) encoding.


`SECRET`	Your API secret
`TIMESTAMP`	Unix timestamp in milliseconds eg. `1545880607433`
`HTTP_VERB`	HTTP verb (`GET`, `POST`, `PUT`, `DELETE`) of the specific API call
`PATH`	The pathname of the specific API call including version. eg. `/v2/quotations`
`BODY`	The request body in JSON string

Useful links

Headers

Example in JavaScript (cont.)

const API_KEY = '914c9e52e6414d9494e299708d176a41'
const TOKEN = `${API_KEY}:${time}:${SIGNATURE}`
// => '914c9e52e6414d9494e299708d176a41:1545880607433:5133946c6a0ba25932cc18fa3aa1b5c3dfa2c7f99de0f8599b28c2da88ed9d42'

Every call MUST include the following headers.

Authorization: hmac <TOKEN>
X-LLM-Country: <YOUR_COUNTRY>
X-Request-ID: <NONCE>

Example

Authorization: hmac 914c9e52e6414d9494e299708d176a41:1545880607433:5133946c6a0ba25932cc18fa3aa1b5c3dfa2c7f99de0f8599b28c2da88ed9d42
X-LLM-Country: TH
X-Request-ID: 211b9d85-a2cc-476f-8675-b61ec923cc27

Authorization

TOKEN = <KEY>:<TIMESTAMP>:<SIGNATURE>


`KEY`	Your API key
`TIMESTAMP`	MUST be identical to `TIMESTAMP` in `SIGNATURE`
`SIGNATURE`	As described in Signature in lowercase hex (base 16)

X-LLM-Country

Please note which country/region/city are you trying to place an order:

Hong Kong, Indonesia, Malaysia, Singapore & Taipei - please state the value in ISO 3166-1 alpha-2 format.
Countries/regions/cities not listed in (1), please specify in UN/LOCODE format. See Available Countries/Regions for details.

X-Request-ID

Provide a Nonce to be used as an unique Request ID. It helps us with preventing replay attacks.

Order Flow

order-flow

Immediate vs Scheduled

Immediate Order

{
  //"scheduleAt": "2020-09-01T14:30:00.00Z",
  "serviceType": "MOTORCYCLE",
  "stops": [<Waypoint>],
  "deliveries": [<DeliveryInfo>],
  "requesterContact": <Contact>,
  "specialRequests": ["COD", "HELP_BUY", "LALABAG"]
}

Scheduled Order

{
  "scheduleAt": "2020-09-01T14:30:00.00Z",
  "serviceType": "MOTORCYCLE",
  "stops": [<Waypoint>],
  "deliveries": [<DeliveryInfo>],
  "requesterContact": <Contact>,
  "specialRequests": ["COD", "HELP_BUY", "LALABAG"]
}

Depending on your delivery needs, you can place an immediate order or a schedule order.

Immediate order (scheduleAt was skipped at the time when placing the order.)
Driver will go to the pick-up point once he accepts the order.
Scheduled order (scheduleAt was specified at the time when placing the order.)
Driver will arrive at the pick-up point by the time specified in scheduleAt.

Our system slots order with scheduleAt to the nearest 10 minutes. For example, an order with scheduleAt as 2020-09-01T14:23:00Z will be automatically adjusted to 2020-09-01T14:30:00Z. This applies to ALL countries/cities/regions EXCEPT India & Hong Kong.

User Cancellation

An order can only be cancelled either:

An order with the status ASSIGNING_DRIVER; or
An order is matched less than 5 minutes - order status changed from ASSIGNING_DRIVER to ON_GOING less than 5 minutes ago. This holds regardless of the actual scheduleAt.

Driver Rejection

Orders can be rejected after they are matched to a driver. When this happens, the order status will revert from ON_GOING/ PICKED_UP to ASSIGNING_DRIVER. Lalamove system will try to match it again with a different driver. If an order has been rejected for the second time, the order status will be revised as REJECTED. Lalamove system will no longer broadcast this order to the driver pool - the system will stop matching a driver for this order.

Expired Orders

An order will be expired if it is not accepted by the driver. Depending the order type (immediate vs scheuduled) order expiry time varies.

Immediate order - 10 minutes after the order is placed
Scheduled order - 10 minutes after the scheduleAt time

Available Countries/Regions

Lalamove API is currently available for the following countries and regions.

Countries or Regions	ISO 3166-1 alpha-2	With UN/LOCODE	Locale Keys
🇧🇷 Brasil	`BR`	`BR_SAO`,`BR_RIO`	`en_BR`,`pt_BR`
🇭🇰 Hong Kong	`HK`	`HK_HKG`	`en_HK`, `zh_HK`
🇮🇳 India	`IN`	`IN_BLR`, `IN_BOM`, `IN_DEL`	`en_IN`, `hi_IN`, `kn_IN`, `mr_IN`
🇮🇩 Indonesia	`ID`	`ID_JKT`	`en_ID`, `id_ID`
🇲🇾 Malaysia	`MY`	`MY_KUL`	`en_MY`, `ms_MY`
🇵🇭 Philippines	`PH`	`PH_MNL`, `PH_CEB`	`en_PH`
🇸🇬 Singapore	`SG`	`SG_SIN`	`en_SG`
🇹🇼 Taiwan	`TW`	`TW_TPE`	`zh_TW`
🇹🇭 Thailand	`TH`	`TH_BKK`, `TH_PYX`	`th_TH`, `en_TH`
🇻🇳 Viet Nam	`VN`	`VN_SGN`, `VN_HAN`	`en_VN`, `vi_VN`

Phone Validation

The following table shows how phone numbers are validated for each country or region.

Countries or Regions	Sample	Regex
🇧🇷 Brasil	11912345678	`/^[0-9]{2}[9]{1}[0-9]{8}$/`
🇭🇰 Hong Kong	37013701	`/^((?!999)([2-9][0-9]{7}))$/`
🇮🇳 India	9234567810	`/^([6-9][0-9]{9}\|22[0-9]{8})$/`
🇮🇩 Indonesia	0212145678	`/^0(8\\d{8,11}\|21\\d{7,8})$/`
🇲🇾 Malaysia	0376886555	`/^0(1[1,5]?\\d{8}\|[4-7,9]\\d{7}\|8[2-9]\\d{6}\|3\\d{8})$/`
🇵🇭 Philippines	09051234567	`/^09[0-9]{9}$\|^0?2[0-9]{7}$\|^0?32[0-9]{7}$/`
🇸🇬 Singapore	81234567	`/^[689]{1}[0-9]{7}$/`
🇹🇼 Taiwan	0912345678	`/^0([1-8]{1}[0-9]{7,8}\|9[0-9]{8})$/`
🇹🇭 Thailand	0812345678	`/^(0[0-9]{8,9}\|[0-9]{4})$/`
🇻🇳 Viet Nam	912345678	`/^0?(2\|[35789])[0-9]{8}$\|^02[48][0-9]{8}$/`

Service Types

Lalamove provides a range of vehicles to cater different needs at different cities.

🇧🇷 Brasil

Key	Description	Shipment restrictions	Sao Paulo `BR_SAO`	Rio `BR_RIO`
`LALAGO`	LALAGO	35 × 40 × 30 cm, 20kg	✅	✅
`LALAPRO`	LALAPRO	40 × 40 × 35 cm, 20kg	✅	✅

Special requests

	Description	`LALAGO`	`LALAPRO`
`INSULATED_BAG`	Insulated Bag	✅	✅

🇭🇰 Hong Kong

Key	Description	Shipment restrictions
`MOTORCYCLE`	Motorcycle	40 × 40 × 40 cm, 10kg
`VAN`	Van	182 × 121 × 121 cm, 700 - 800 kg
`TRUCK550`	5.5 Ton	450 × 195 × 195 cm, 800 - 1,200 kg

🇮🇳 India

Key	Description	Shipment restrictions	Bangalore `IN_BLR`	Mumbai `IN_BOM`	Delhi `IN_DEL`
`MOTORCYCLE`	Motorcycle	40 x 40 x 40 cm, 20 kg	✅	✅	✅
`THREE_WHEELER`	Three-Wheeler	150 × 130 × 130 cm, 500 kg			✅
`TATA7FT`	7ft Tata Ace	220 × 140 × 180 cm, 750 kg	✅	✅	✅
`TATA8FT`	8ft Tata Ace	240 × 140 × 180 cm, 750 kg		✅

Special requests

	Description	`MOTORCYCLE`	`THREE_WHEELER`	`TATA7FT`	`TATA8FT`
`DOOR2DOOR`	Moving and Unloading		✅	✅	✅
`COD`	COD	✅

🇮🇩 Indonesia

Jakarta

Key	Description	Shipment restrictions
`MOTORCYCLE`	Motor	40 x 40 x 40 cm, 20 kg
`MPV`	Mobil	175 x 100 x 85 cm, 350 kg
`VAN`	Van	210 x 150 x 120 cm, 600 kg
`TRUCK175`	Pickup Bak	200 x 160 x 120 cm, 800 kg

Special requests

	Description	`MOTORCYCLE`	`MPV`	`VAN`	`TRUCK175`
`PURCHASE_SERVICE`	Purchase Service < 300K Rp	✅
`DOOR2DOOR`	Door to Door Delivery		✅	✅	✅
`EXTRA_HELPER`	Door to Door Delivery with 1 Helper			✅
`EXTRA_HELPER_TRUCK175`	Door to Door Delivery with 1 Helper				✅
`ROUNDTRIP_MOTORYCYCLE`	Roundtrip	✅
`LALABAG`	Lalabag	✅

🇲🇾 Malaysia

Kuala Lumpur

Key	Description	Shipment restrictions
`MOTORCYCLE`	Motorcycle	36 x 36 x 36 cm, 10 kg
`CAR`	Car	50 x 50 x 50 cm, 40 kg
`VAN`	Van	244 cm × 91 cm × 122 cm, 500 kg
`4x4`	4x4	250 kg
`TRUCK330`	1-Ton Lorry	275 x 152 x 152 cm・1,000 kg
`TRUCK550`	3-Ton Lorry	427 x 220 x 213 cm・3,000 kg

Special requests

	Description	`MOTORCYCLE`	`CAR`	`TRUCK330`	`TRUCK550`
`PURCHASE_SERVICE`	Buy4U	✅
`LALABAG`	Lalabag	✅
`DOOR2DOOR`	Door to Door delivery		✅
`DOOR2DOOR_TRUCK330`	Moving Services by Driver			✅
`DOOR2DOOR_TRUCK550`	Moving Services by Driver				✅
`DOOR2DOOR_1HELPER_TRUCK330`	Moving Services by Driver + 1 Helper			✅
`DOOR2DOOR_1HELPER_TRUCK550`	Moving Services by Driver + 1 Helper				✅
`DOOR2DOOR_2HELPER_TRUCK330`	Moving Services by Driver + 2 Helpers			✅
`DOOR2DOOR_2HELPER_TRUCK550`	Moving Services by Driver + 2 Helpers				✅
`RETURNTRIP`	Return Trip	✅	✅
`LOADING_SERVICE`	Loading Service			✅	✅

🇵🇭 Philippines

Key	Description	Shipment restrictions	Manila `PH_MNL`	Cebu `PH_CEB`
`MOTORCYCLE`	Motorcycle	1.6 x 1.25 x 1.6ft, 20 kg	✅	✅
`MPV`	UV (Small)	4 x 3.2 x 2.8 ft, 300 kg	✅	✅
`VAN`	Van	7 x 4 x 3.5 ft, 600 kg	✅
`TRUCK330`	FB/L300	7 x 4 x 4 ft, 1,000 kg	✅	✅

Special requests

	Description	`MOTORCYCLE`	`MPV`	`VAN`	`TRUCK330`
`COD`	Cash Handling	✅
`LALABAG`	Insulated Box	✅
`QUEUEING_MOTORCYCLE`	Queueing Service	✅
`PURCHASE_SERVICE`	Purchase Service (>30minutes waiting: +‎₱60)	✅
`DRIVER_CARRIES`	Driver Carries (max 50kg)		✅	✅	✅
`1ASSISTANT_1_MINUS_2DROPS`	1 Assistant: 1-2 drops		✅	✅	✅
`1ASSISTANT_3_MINUS_4DROPS`	1 Assistant: 3-4 drops		✅	✅	✅
`1ASSISTANT_5_PLUS_DROPS`	1 Assistant: 5+ drops		✅	✅	✅

🇸🇬 Singapore

Key	Description	Shipment restrictions
`MOTORCYCLE`	Bike	40 × 25 × 25 cm, 8 kg
`CAR`	Car	70 × 50 × 50 cm, 20 kg
`MINIVAN`	1.7m Van	160 × 120 × 100 cm
`VAN`	2.4m Van	230 × 120 × 120 cm
`TRUCK330`	10ft Lorry	290 × 140 × 170 cm
`TRUCK550`	14ft Lorry	420 × 170 × 190 cm

Special requests

	Description	`MOTORCYCLE`	`CAR`	`MINIVAN`	`VAN`	`TRUCK330`	`TRUCK550`
`COD`	Cash on delivery	✅	✅	✅	✅	✅	✅
`RESTRICTED`	Secured Zone	✅	✅	✅	✅	✅	✅
`RETURNTRIP`	Return Trip (for documents only)		✅	✅	✅
`RETURNTRIP_LORRY`	Return Trip (for documents only)					✅	✅
`MOVING_DRIVER_1HELPER_VAN`	Moving service: Driver + 1 Helper			✅	✅
`MOVING_DRIVER_2HELPER_VAN`	Moving service: Driver + 2 Helpers			✅	✅
`MOVING_DRIVER`	Moving service: Driver					✅	✅
`MOVING_DRIVER_1HELPER`	Moving service: Driver + 1 Helper					✅	✅
`MOVING_DRIVER_2HELPER`	Moving service: Driver + 2 Helpers					✅	✅
`TAILGATE`	Tailgate					✅	✅
`COVERED`	Covered					✅	✅

🇹🇼 Taiwan

Taipei

Key	Description	Shipment restrictions
`MOTORCYCLE`	Motorcycle	30 × 60 × 40 cm, 20 kg
`MPV`	SUV	100 × 100 × 100 cm, 200 kg (individual item weighing < 20 kg)
`VAN`	Van	150 × 100 × 100 cm, 300 kg (individual items weighing < 20 kg)
`TRUCK175`	150 Cubic Truck	200 × 120 × 120 cm, 500 kg (individual items weighing < 20 kg)
`TRUCK330`	Truck	200 × 120 × 120 cm, 500 kg (individual items weighing < 20 kg)

Special requests

	Description	`MOTORCYCLE`	`MPV`	`VAN`	`TRUCK175`	`TRUCK330`
`LALABAG`	Lalamove專用保溫袋詳情按此	✅
`HELP_BUY`	需代付款，上限 $2000(請在remarks欄備註金額) 詳情按此	✅	✅	✅

🇹🇭 Thailand

Key	Description	Shipment restrictions	Bangkok `TH_BKK`	Pattaya `TH_PYX`
`MOTORCYCLE`	Motorcycle	50 × 50 × 50 cm, 20 kg	✅	✅
`MPV`	Hatchback	115 × 115 × 80 cm, 100 kg	✅	✅
`TRUCK330`	Pick-Up Truck	170 × 150 × 170 cm, 1,000 kg	✅	✅

Special requests

	Description	`MOTORCYCLE`	`MPV`	`TRUCK330`
`COD`	Cash on delivery	✅	✅	✅
`HELP_BUY`	Purchase Service (THB 1 - 1,000). Input your details, amount and price of the desired goods in `DeliveryInfo.remarks` Make sure the recepient carries sufficient amount of cash to pay our driver	✅
`LALABAG`	Food Delivery Box	✅
`ROUNDTRIP`	Round Trip		✅	✅
`DOOR2DOOR`	Door to door (by driver)		✅	✅
`PURCHASE_SERVICE_TIER_2`	Purchase Service (THB 1,000 - 2,000)	✅

🇻🇳 Vietnam

Key	Description	Shipment restrictions	HCM City `VN_SGN`	Hanoi `VN_HAN`
`LALANOW`	LalaNow	40 x 40 x 40 cm, 30 kg	✅	✅
`LALA2H`	Lala2h	40 x 40 x 40 cm, 30 kg	✅	✅
`MOTORCYCLE`	Motorcycle	40 x 40 x 40 cm, 30 kg	✅	✅
`TRUCK175`	Truck	200 x 120 x 120 cm, 500 kg	✅
`TRUCK330`	Truck	300 x 160 x 160 cm, 1,000 kg	✅

Special requests

	Description	`LALANOW`	`LALA2H`	`MOTORCYCLE`	`TRUCK175`	`TRUCK330`
`HELP_BUY`	Purchase Service	✅	✅	✅
`LALABAG`	Insulated Box	✅	✅	✅
`LALABAG_BIG`	40 x 40 x 40 cm	✅	✅	✅ (HCM City ONLY)
`DOOR2DOOR_DRIVER`	Door-to-door delivery	✅	✅	✅
`GROUND_FLOOR_ONE_WAY`	Moving Help: Ground floor 1 way				✅
`GROUND_FLOOR_ONE_WAY_2`	Moving Help: Ground floor 1 way					✅
`UPSTAIR_DOWNSTAIR_ONE_WAY`	Moving Help: Stairs 1 way				✅
`UPSTAIR_DOWNSTAIR_ONE_WAY_2`	Moving Help: Stairs 1 way					✅
`ROUNDTRIP_TRUCK175`	Round Trip				✅
`ROUNDTRIP_TRUCK330`	Round Trip					✅
`DOOR2DOOR_1HELPER_TRUCK175`	Door-to-door delivery + 1 Helper				✅
`DOOR2DOOR_1HELPER_TRUCK330`	Door-to-door delivery + 1 Helper					✅

Get Quotation

POST https://rest.lalamove.com/v2/quotations

POST https://rest.br.lalamove.com/v2/quotations

POST https://sandbox-rest.lalamove.com/v2/quotations

Body

{
  "scheduleAt": "2020-09-01T14:30:00.00Z",
  "serviceType": "MOTORCYCLE",
  "stops": [<Waypoint>],
  "deliveries": [<DeliveryInfo>],
  "requesterContact": <Contact>,
  "specialRequests": ["COD", "HELP_BUY", "LALABAG"]
}

Responses

201 Quotation Created

{ "totalFee": "108000", "totalFeeCurrency": "THB" }

409 Stops and Deliveries mismatch, see DeliveryInfo

{ "message": "ERR_DELIVERY_MISMATCH" }

409 Not enough stops, number of stops should be between 2 and 10

{ "message": "ERR_INSUFFICIENT_STOPS" }

409 Reached maximum stops, Number of stops should be between 2 and 10

{ "message": "ERR_TOO_MANY_STOPS" }

409 Invalid payment method

{ "message": "ERR_INVALID_PAYMENT_METHOD" }

409 Invalid locale, refer to Waypoint

{ "message": "ERR_INVALID_LOCALE" }

409 Invalid phone number, refer to Phone validations

{ "message": "ERR_INVALID_PHONE_NUMBER" }

409 scheduleAt datetime is in the past

Be reminded that scheduleAt is in UTC timezone.

{ "message": "ERR_INVALID_SCHEDULE_TIME" }

409 No such service type, make sure to stick to Service types in your country/region

{ "message": "ERR_INVALID_SERVICE_TYPE" }

409 No such special request(s), make sure that special requests match with selected Service types

{ "message": "ERR_INVALID_SPECIAL_REQUEST" }

409 Out of service area

{ "message": "ERR_OUT_OF_SERVICE_AREA" }

409 Fail to reverse from address to location, provide lat and lng

{ "message": "ERR_REVERSE_GEOCODE_FAILURE" }

POST /v2/quotations

Request a quotation.

Will return an object containing the fee amount and currency of based on information provided.

Body

Required fields
`serviceType`	`string`	The type of vechicle. See service types available in your country/region
`stops`	`Waypoint[]`	Array of `Waypoint`s (minimum 2, maximum 10)
`deliveries`	`DeliveryInfo[]`	Array of `DeliveryInfo`s
`requesterContact`	`Contact`	Contact person at pick up point aka `stop[0]`, see `Contact`

Optional fields
`scheduleAt`	`string`	Pick up time in UTC timezone and ISO 8601 format; omit this if you are placing an immediate order
`specialRequests`	`string[]`	See special requests available in your country/region

scheduleAt

IMPORTANT: scheduleAt is in UTC timezone.

For example, you are placing an order in Singapore at 2020-07-10 15:00 (local time). As Singapore is in UTC+8 timezone, and scheduleAt takes time in UTC. In this case, you should put 2020-07-10T07:00:00.000Z.

Your Local Time	UTC Time

ISO 8601 format

requesterContact

If you are a business, this will need to be your physical pick up location's contact information. Example for a multi-branch business:

Branch	`requesterContact`
ACME Branch A	`{name: "ACME Branch A", phone: "8912121212"}`
ACME Branch B	`{name: "ACME Branch B", phone: "8912121213"}`
ACME Branch C	`{name: "ACME Branch C", phone: "8912121214"}`

The pick up location's (first stop) DeliveryInfo is ALWAYS tied to requesterContact.

Waypoint

Waypoint

{
  "location": { 
    "lat": "13.740167", 
    "lng": "100.535237" 
    },
  "addresses": {
    "th_TH": {
      "displayString": "444 ถนน พญาไท แขวง วังใหม่ เขต ปทุมวัน กรุงเทพมหานคร 10330 ประเทศไทย",
      "country": "TH"
    }
  }
}

LOCALE is composed of ISO 639-1 language code and ISO 3166-1 alpha-2 country code as follow:

{ISO 639-1}_{ISO 3166-1 alpha-2}.

See what locale keys are available in your country/region


`location.lat`	`string`	Latitude
`location.lng`	`string`	Longitude
`addresses[<LOCALE>].displayString`	`string`	Street address in plain text. Use `remarks` in DeliveryInfo for building, floor and flat
`addresses[<LOCALE>].country`	`string`	Country code must match with `X-LLM-Country` in the request headers. See Available countries

DeliveryInfo

DeliveryInfo

{
  "toStop": 1,
  "toContact": <Contact>
  "remarks": "ORDER#94\r\n1. Tshirt จำนวน 1\r\n2. Hoodie จำนวน 1\r\n"
}

Contact person, mobile phone number and remarks for each Waypoint excluding the pick up point.


`toStop`		`number`	The index of waypoint in `stops` this information associates with, has to be `>= 1`, since the first stop's Delivery Info is tided to `requesterContact`
`toContact`		`Contact`	See `Contact`
`remarks`	🤷‍♀️	`string`	Additional info about the delivery. eg. building, floor and flat. Use newline `\r\n` for better readability

🤷‍♀️ - Optional

Contact

Contact

// We accept phone number with or without country code. If you do supply a country code, please put "+" before the country code. For example, "+85237013701" or "37013701" are both acceptable for Hong Kong.
{
    "name": "Chris Wong", 
    "phone": "37013701" 
}


`name`	`string`	The name of the contact person
`phone`	`string`	Must be a valid phone number. See Phone Validation on how we validate phone numbers for each country/region.

Place Order

POST https://rest.lalamove.com/v2/orders

POST https://rest.br.lalamove.com/v2/orders

POST https://sandbox-rest.lalamove.com/v2/orders

Body

{
  "quotedTotalFee": { "amount": "108000", "currency": "THB" },
  "sms": false,
  // ... merge with body used for quotation
}

IMPORTANT: Merge the above with the body that was used for requesting quotation.

Responses

201 Order Created

{
  "customerOrderId": "<DEPRECATED_ORDER_ID>",
  "orderRef": "<LALAMOVE_ORDER_ID>"
}

402 You have insufficient credit. Please top up your wallet

{ "message": "ERR_INSUFFICIENT_CREDIT" }

409 The currency you provided in quotedTotalFee.currency is not a valid currency

{ "message": "ERR_INVALID_CURRENCY" }

409 The amount or currency you provided in quotedTotalFee doesn't match quotation

{ "message": "ERR_PRICE_MISMATCH" }

429 Too Many Requests

// no body

POST /v2/orders

Provide the totalFee and totalFeeCurrency received from /quotations as quotedTotalFee.amount and quotedTotalFee.currency merged with the exact same body used for /quotations.

The amount and currency of quotedTotalFee MUST match with quotation.

Body


`quotedTotalFee.amount`		`string`	`totalFee` from `/quotations`
`quotedTotalFee.currency`		`string`	`totalFeeCurrency` from `/quotations`
`sms`	🤷‍♀️	`boolean`	Send delivery updates via SMS to THE recipient, or the recipient of the LAST STOP for multi-stop orders. Default to `true`

🤷‍♀️ - Optional

sms

For sms function to work properly, please also check with your account manager for details.

Response


`customerOrderId`	UUID order id (Deprecated)
`orderRef`	Lalamove Order ID

Order Details

GET https://rest.lalamove.com/v2/orders/{id}

GET https://rest.br.lalamove.com/v2/orders/{id}

GET https://sandbox-rest.lalamove.com/v2/orders/{id}

Responses

200 ASSIGNING_DRIVER

{
  "status": "ASSIGNING_DRIVER",
  "price": { "amount": "108000", "currency": "THB" },
  "driverId": ""
}

200 ON_GOING

{
  "status": "ON_GOING",
  "price": { "amount": "108000", "currency": "THB" },
  "driverId": "33522"
}

200 CANCELED

{
  "status": "CANCELED",
  "price": { "amount": "108000", "currency": "THB" },
  "driverId": ""
}

200 PICKED_UP

{
  "status": "PICKED_UP",
  "price": { "amount": "108000", "currency": "THB" },
  "driverId": "33522"
}

200 REJECTED

{
  "status": "REJECTED",
  "price": { "amount": "108000", "currency": "THB" },
  "driverId": ""
}

200 COMPLETED

{
  "status": "COMPLETED"
  "price": { "amount": "108000", "currency": "THB" },
  "driverId": "33522"
}

200 EXPIRED

{
  "status": "EXPIRED",
  "price": { "amount": "108000", "currency": "THB" },
  "driverId": ""
}

GET /v2/orders/{id}

URL Params


`id`	`<LALAMOVE_ORDER_ID>`

Order Status

status


`ASSIGNING_DRIVER`	Trying to match shipment with a driver.
`ON_GOING`	A driver has accepted the order.
`PICKED_UP`	The driver has picked up the order.
`COMPLETED`	The order has been delivered sucessfully and transaction has concluded.
`CANCELED`	User has canceled the order.
`REJECTED`	The order was matched and rejected twice by two drivers in a row, see Order Flow.
`EXPIRED`	The order expired as no drivers accepted the order.

A driver can only pick up an order that has scheduleAt less than 30 minutes ahead. The order status will change from ON_GOING to PICKED_UP if such action is effective. For example, an order with scheduleAt as 15:00, the driver is not allowed to click picked-up until the time reaches 14:31.

Driver Details

GET https://rest.br.lalamove.com/v2/orders/{orderId}/drivers/{driverId}

GET https://rest.lalamove.com/v2/orders/{orderId}/drivers/{driverId}

GET https://sandbox-rest.lalamove.com/v2/orders/{orderId}/drivers/{driverId}

Responses: 200

{
  "name": "David",
  "phone": "0978787878",
  "plateNumber": "SG-9393",
  "photo": "<PROFILE_PHOTO_URL>"
}

GET /v2/orders/{orderId}/drivers/{driverId}

Retrieve driver's information.

URL Params


`orderId`	`<LALAMOVE_ORDER_ID>`
`driverId`	`driverId` from `/orders/{id}` response

Driver Location

GET https://rest.br.lalamove.com/v2/orders/{orderId}/drivers/{driverId}/location

GET https://rest.lalamove.com/v2/orders/{orderId}/drivers/{driverId}/location

GET https://sandbox-rest.lalamove.com/v2/orders/{orderId}/drivers/{driverId}/location

Responses: 200

{
  "location": { "lat": "13.740167", "lng": "100.535237" },
  "updatedAt": "2017-12-01T14:30.00Z"
}

Responses: 403

// Empty

GET /v2/orders/{orderId}/drivers/{driverId}/location

Retrieve driver's lastest location in latitude and longitude.

This information is available starting 1 hour prior to datetime specified in scheduleAt datetime and remain accessible until the order is completed. Attempts made outside of this time window will get 403 Forbidden response.

URL Params


`orderId`	`<LALAMOVE_ORDER_ID>`
`driverId`	`driverId` from `/orders/{id}` response

Cancel Order

PUT https://rest.br.lalamove.com/v2/orders/{id}/cancel

PUT https://rest.lalamove.com/v2/orders/{id}/cancel

PUT https://sandbox-rest.lalamove.com/v2/orders/{id}/cancel

Responses

200

{}

409 Cancellation Forbidden

{ "message": "ERR_CANCELLATION_FORBIDDEN" }

PUT /v2/orders/{id}/cancel

Please refer to our cancellation policy here.

Attempts to cancel an order that does not comply with our cancellation policy will get ERR_CANCELLATION_FORBIDDEN as response.

URL Params


`id`	`<LALAMOVE_ORDER_ID>`

Errors

The Lalamove API uses the following error codes:

Error Code	Meaning
`400` -- Bad Request	Your request is invalid. Make sure the body is a valid JSON string.
`401` -- Unauthorized	Your authorization token is wrong. Make sure to follow instructions in Authentication.
`402` -- Payment Required	You have insufficient Credit.
`403` -- Forbidden	Access to order or driver details is unauthorized.
`404` -- Not Found	The specified Order or Driver could not be found.
`409` -- Conflict	`ERR_INVALID_COUNTRY` -- Incorrect country. `ERR_INVALID_PARAMS` --- General validation error. `ERR_REQUIRED_FIELD` -- Missing required fields.
`429` -- Too Many Requests	You're sending in too many requests.
`500` -- Internal Server Error	We had a problem with our server. Try again later.

Go-Live

Customers have their own use case scenarios - we do not mandate customers to use all of our APIs. However, please make sure your integration includes both /v2/quotations and /v2/orders.
Before rolling out the intergration to production (or commonly known as "Go-Live"), our sales and operation experts will help you conduct a soft-launch with real drivers to make sure operational readiness on both sides.
Official Launch - Please notify local sales the date for going live, so we can communicate to drivers and make sure we successfully scale your business.

Tutorial

We are preparing the tutorials at the moment. Stay tuned!

In the meantime, we highly recommend you to start using our API with POSTMAN.

FAQ

Why do I keep getting 401 - Unauthorized error?

Make sure you are follow the instruction on Authentication closely.

rawSignatureWithBody = `${time}\r\n${method}\r\n${path}\r\n\r\n${body}`;
rawSignatureNoBody = `${time}\r\n${method}\r\n${path}\r\n\r\n`;
// the last \r\n\r\n is untouched

If you are having trouble with requests without body like get order details, make sure you leave the line break characters untouched.

You may also want to refer to "API Libraries (Third-party)" in the Support section.

Does Lalamove API offer webhooks?

We do not provide webhooks. However you can perform polling on /v2/orders/<order_id> using CRON jobs at the maximum rate of 1 request per order per minute to detect status updates until the order is COMPLETED.

How do I get notifited when an order status has changed?

You will need to implement a polling mechanism to retrieve order status periodically. We will not push or notify changes programmatically.

Can I just place an order directly without getting a quotation everytime?

Technically yes. If you know the price in advance, for example there are some pre-defined routes that you have to order for a deliveries on a regular basis. You can store the pricing in previous quotations and apply the price directly to POST /v2/orders as quotedTotalFee.

How do I make changes to order status on Sandbox?

Support

API Libraries (Third-party)

Currently we do not offer any official SDK/libraries for our API. However, there are some libraries built by the community that might help with your integration.


C#	https://repl.it/@jakech/LLM-Auth-C
NodeJS	https://github.com/yamdraco/lalamove-js
PHP	https://github.com/yamdraco/lalamove-php
Python	https://repl.it/@jakech/LLM-Auth-Python
Ruby	https://repl.it/@jakech/LLM-Auth-Ruby

Contact

For technical support, please email api-support@lalamove.com.