parcels
List parcels filtered by state.
Returns a paginated list of parcels that match the specified states.
get/v1/parcels
Query parameters
statesstring[] required
Filter results by one or more parcel states. See parcel states for a description of each value.
pagenumber required
Page number to retrieve (0-based).
Response
Success
Example response
{
"parcels": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"external_id": "parcel_001",
"pickup_info": {
"addr": "Calle de Pradillo, 42, Madrid",
"contact": {
"name": "John",
"phone": "+34666000000"
},
"instr": "Knock the door three times",
"loc": {
"lat": 40.4489254,
"lon": -3.6730293
},
"code": "ABC123",
"hub_external_id": "magic_store_santa_fe"
},
"dropoff_info": {
"addr": "Calle de Pradillo, 42, Madrid",
"contact": {
"name": "John",
"phone": "+34666000000"
},
"instr": "Knock the door three times",
"loc": {
"lat": 40.4489254,
"lon": -3.6730293
},
"hub_external_id": "magic_store_santa_fe"
},
"dimensions": {
"height": 10,
"length": 10,
"width": 10
},
"weight": {
"value": 1500
},
"price": {
"declared_value": 630,
"collected_value": 630,
"currency": "EUR"
},
"created_at": "2021-12-02T10:12:07.753Z",
"updated_at": "2021-12-02T10:12:07.753Z"
}
],
"page": 2,
"page_size": 20,
"more_pages": true
}