Get pickups.
Pickup status
Number of records per page
Start date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+00:00, default: 24hrs ago)
End date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+00:00, default: NOW())
The 'next_token' is a short code provided in the response when there are more 'pickup' records to fetch. Use this code in your next request to get the next batch of records. If 'next_token' is not included or is null, it means there are no more records to fetch.
Content-Type
Get pickups.
Meta data object.
Code of Meta
Message of Meta
Details of Meta
Whether this request will be retryable or not
This array contains all pickups data. Please refer to pickup object for pickup object details.
{ "meta": { "code": 200, "type": "OK", "message": "Everything worked as expected." }, "data": { "next_token": "string", "limit": 0, "created_at_min": "string", "created_at_max": "string", "pickups": [ { "id": "00000000-0000-0000-0000-000000000000", "status": "created", "pickup_confirmation_numbers": [ "00000000-0000-0000-0000-000000000000" ], "pickup_date": "2023-09-10", "pickup_start_time": "09:00:00", "pickup_end_time": "18:00:00", "pickup_from": { "company_name": "AfterShip Shipping", "contact_name": "AfterShip Shipping", "street1": "230 W 200 S LBBY", "city": "Salt Lake City", "state": "UT", "postal_code": "84101", "country": "USA", "phone": "123456789", "email": "[email protected]", "type": "business" }, "label_ids": [ "00000000-0000-0000-0000-000000000000" ], "created_at": "2022-05-09T07:54:13.024Z", "updated_at": "2022-09-09T07:54:24.569Z" } ] } }