Retrieve a list of pickups
GET {{baseUrl}}/pickups?limit=<integer>
This endpoint retrieves information about all the pickups which have been created from your account. This is limited to the carriers which support pickups via the API. The response includes information about when the pickup was scheduled, the latest status, the parcel tracking number and the time frame in which the pickup is due to take place.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limit | string | Amount of pickups that will be shown per page. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"next":"\u003cstring\u003e","previous":"\u003cstring\u003e","pickups":[{"id":"\u003clong\u003e","carrier":"\u003cstring\u003e","country":"DE","pickup_from":"\u003cdateTime\u003e","pickup_status":"Cancelled","created_at":"\u003cdateTime\u003e","cancelled_at":"\u003cdateTime\u003e","tracking_number":"\u003cstring\u003e","pickup_until":"\u003cdateTime\u003e","contract":"\u003cinteger\u003e"},{"id":"\u003clong\u003e","carrier":"\u003cstring\u003e","country":"NL","pickup_from":"\u003cdateTime\u003e","pickup_status":"Announcing","created_at":"\u003cdateTime\u003e","cancelled_at":"\u003cdateTime\u003e","tracking_number":"\u003cstring\u003e","pickup_until":"\u003cdateTime\u003e","contract":"\u003cinteger\u003e"}]}