Skip to main content

List pickup slots

GET/client_api/v2/orders/{order_id}/pickup_availabilities

The days and times the carrier can collect the order. Pick a slot from here before you book a 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.

Returns

Returns a list.

Errors

  • 401Unauthorized
    The token is missing, expired or invalid. Sign in again.
View as Markdown
GET /client_api/v2/orders/{order_id}/pickup_availabilities
1curl -X GET "https://sandbox-api.vatit-stream.com/client_api/v2/orders/1/pickup_availabilities" \
2 -H "Authorization: Bearer $API_TOKEN"
Response
[
{
"earliest_pickup_time": "09:00",
"latest_pickup_end_time": "16:30",
"latest_pickup_start_time": "15:00",
"minimum_access_duration_minutes": 90,
"pickup_date": "2026-10-26",
"time_zone_id": null
}
]
API ExplorerSandbox

Pick a call on the right and run it. Every call goes to the sandbox, so nothing is really shipped or charged. The answer appears here.