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.

Note: This /v3/pickup endpoint will be deprecated in the future

Create Pickup Order

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

POST Create Pickup Order

POST /v3/pickup

Request Data

Paramater

Type

Description

data.order_activation.
order_id

Array of Strings

The ID of the order(s)

data.order_activation.
pickup_time

RFC3339

Time 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": [
                "215GRRV8Y55VQ"
            ],
            "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 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

Parameter

Description

metadata

Metadata information

metadata.path

Api endpoint path

metadata.http_status_code

Http status code

metadata.http_status

Http status

metadata.timestamp

Timestamp

data

All important information about pickup request created

data.order_activations.order_id

Shipper Order ID

data.order_activations.pickup_code

Pickup code used by Shipper Driver

data.order_activations.is_activate

Activation order status. Used to determine if the order is successfully requested for pickup.

data.order_activations.pickup_time

Assigned pickup time for the order