Create Pickup Order


New Pickup API is available

The new endpoint will enable you to select available timeslot and create a pickup request with the specific timeslot. Check the new endpoint here.

Create Pickup Order

Authorizations : X-API-Key_Header
Request Body Schema : application/json

POST Create Pickup Order

POST /v3/pickup

Request Data

Array of StringsThe ID of the order(s)
RFC3339Time of order(s) to be collected

For Instant and Same Day Service, filling in or leaving the pickup_time empty will by default request a driver to collect the order at that time.

Sample Request and Response

curl --location --request POST '{{baseUrl}}/v3/pickup' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "order_activation": {
            "order_id": [
            "pickup_time": "2021-05-27T17:58:00+07:00"
    "metadata": {
        "path": "/v3/pickup",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1622045027
    "data": {
        "order_activations": [
                "order_id": "215GRRV8Y55VQ",
                "pickup_code": "P21051927D8",
                "is_activate": true,
                "pickup_time": "2021-05-27T17:58:00+07:00"


Important Notes

Maximum order ids per request is 30

Important Return Parameters

  • pickup_code - For the driver's reference upon collecting the orders.
  • is_active - Used to determine if the order is successfully requested for pickup.

Response List

metadataMetadata information
metadata.pathApi endpoint path
metadata.http_status_codeHttp status code
metadata.http_statusHttp status
dataAll important information about pickup request created
data.order_activations.order_idShipper Order ID
data.order_activations.pickup_codePickup code used by Shipper Driver
data.order_activations.is_activateActivation order status. Used to determine if the order is successfully requested for pickup.
data.order_activations.pickup_timeAssigned pickup time for the order