Create Pickup Order
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) |
Sample Request and Response
curl --location --request POST '{{baseUrl}}/v3/pickup' \
--header 'Content-Type: application/json' \
--data-raw '{
"data": {
"order_activation": {
"order_id": [
"215GRRV8Y55VQ"
]
}
}
}'
{
"metadata": {
"path": "/v3/pickup",
"http_status_code": 200,
"http_status": "OK",
"timestamp": 1622045027
},
"data": {
"order_activations": [
{
"order_id": "215GRRV8Y55VQ",
"pickup_code": null, --> no longer in use
"is_activate": true,
"pickup_time": null --> no longer in use
}
]
}
}
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
| 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 | |
| data.order_activations.is_activate | Activation order status. Used to determine if the order is successfully requested for pickup. |
| data.order_activations.pickup_time |
Updated 8 months ago