Book a pickup

POST/client_api/v2/orders/{order_id}/schedule_pickups

Books the carrier to collect the order, inside one of the slots from List pickup slots. Booking again cancels the earlier pickup.

Path parameters

order_idintegerRequired
The order's id.
Read the ids from List orders in the environment you are calling: they differ between the sandbox and production.

Parameters

scheduled_pickupobjectRequired
The pickup to book.

Returns

Returns the scheduled pickup.

Errors

400Bad Request
The request body isn't valid JSON, or something failed on our side.
401Unauthorized
The token is missing, expired or invalid. Sign in again.

View as Markdown

POST /client_api/v2/orders/{order_id}/schedule_pickups

1curl -X POST "https://sandbox-api.vatit-stream.com/client_api/v2/orders/4/schedule_pickups" \
2  -H "Authorization: Bearer $API_TOKEN" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "scheduled_pickup": {
6      "scheduled_date": "2026-10-26",
7      "time_from": "10:00",
8      "time_to": "16:00",
9      "pickup_instructions": "Collect from reception and ask for Thandi"
10    }
11  }'

Response

{
  "scheduled_pickup": {
    "id": 1,
    "cancellable": true,
    "confirmation_number": "FDX-PU-4417823",
    "error_message": "",
    "freight_confirmation_number": null,
    "pickup_instructions": "Collect from reception and ask for Thandi",
    "scheduled_date": "2026/10/26 00:00:00 UTC",
    "status": "scheduled",
    "time_from": "10:00:00",
    "time_to": "16:00:00"
  }
}