List pickups

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

Every pickup booked for the order, newest first, including cancelled ones.

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 the result.

Errors

• 401Unauthorized
  The token is missing, expired or invalid. Sign in again.

View as Markdown

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

cURLJavaScriptPythonPHPC#Ruby

1curl -X GET "https://sandbox-api.vatit-stream.com/client_api/v2/orders/5/schedule_pickups" \
2  -H "Authorization: Bearer $API_TOKEN"

Response200 OK401 Unauthorized

{
  "scheduled_pickups": [
    {
      "id": 2,
      "cancellable": true,
      "confirmation_number": "FDX-PU-4417823",
      "error_message": "",
      "freight_confirmation_number": null,
      "order_status": "awaiting_pickup",
      "scheduled_date": "2026/10/26 00:00:00 UTC",
      "status": "scheduled",
      "time_from": "10:00:00",
      "time_to": "16:00:00"
    }
  ],
  "meta": {
    "page_count": 1,
    "record_count": 1
  }
}