Create Pickup Order with Timeslot

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

POST Create Pickup Order with Timeslot

POST /v3/pickup/timeslot

Request Data

Parameter	Type	Description
data.order_activation. order_id	Array of Strings	The ID of the order(s)
data.order_activation. timezone	String	Timezone that is used in the get timezone endpoint. Values: 1. Asia/Jakarta 2. Asia/Makassar 3. Asia/Jayapura
data.order_activation. start_time	String	start_time from the response of the get timezone endpoint
data.order_activation. end_time	String	end_time from the response of the get timezone endpoint

For Instant, Same Day, and hubless orders, filling in or leaving the timezone, start_time, end_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/timeslot' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "order_activation": {
            "order_id": [
                "215GRRV8Y55VQ"
            ],
            "timezone" : "Asia/Jakarta"
            "start_time": "2021-09-09T15:00:00+07:00",
            "end_time": "2021-09-09T17:59:00+07:00"
        }
    }
}'

{
	"metadata": {
		"path": "/v3/pickup/timeslot",
		"http_status_code": 200,
		"http_status": "OK",
		"timestamp": 1658128845
	},
	"data": {
		"order_activations": [
		{
			"order_id": "227NJVZXYZWD7",
			"pickup_code": "P22075396E2",
			"is_activate": true,
			"pickup_time": "2022-07-19T09:00:00+07:00"
		}]
	}
}

❗️
Important Notes
Maximum order ids per request is 30

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_activation	All important information about the orders that have been activated
data.order_activation.[].order_id	Shipper Order ID
data.order_activation.[].pickup_code	Pickup code used by Shipper Driver
data.order_activation.[].is_activate	Activation order status. Used to determine if the order is successfully requested for pickup.
data.order_activation.[].pickup_time	Assigned pickup time for the order

Create Pickup Order with Timeslot

❗️Important Notes

❗️
Important Notes