Shipping Labels
List labels
List paginated shipping labels for the current user, optionally filtered by status.
Authorization
authorization AuthorizationBearer <token>
In: header
Query Parameters
status?string
Filter by shipping label status
Value in
"PRE_TRANSIT" | "IN_TRANSIT" | "OUT_FOR_DELIVERY" | "DELIVERED" | "RETURN_TO_SENDER" | "ERROR" | "VOIDED"page?integer
Page number
page_size?integer
Page size
Response Body
application/json
application/json
curl -X GET "https://api.parsel.app/shipping_labels?page=1&page_size=10"{
"data": [
{
"created_at": {},
"id": "123e4567-e89b-12d3-a456-426614174000",
"label_url": "https://example.com/labels/123.pdf",
"shipping_rate": {
"carrier": "UPS",
"estimated_delivery_date": {},
"estimated_delivery_days": 3,
"id": "123e4567-e89b-12d3-a456-426614174001",
"price": {
"amount": 10,
"currency": "USD"
},
"service": "Ground"
},
"shipping_rate_id": "123e4567-e89b-12d3-a456-426614174001",
"status": "PRE_TRANSIT",
"tracking_code": "1Z999AA10123456784",
"updated_at": {}
}
],
"metadata": {
"current_page": 1,
"end_cursor": null,
"has_next_page": true,
"has_previous_page": false,
"page_size": 25,
"start_cursor": null,
"total_count": 87,
"total_pages": 4
}
}{
"errors": {
"message": "This action requires the WRITE_SHIPMENTS scope",
"required_scope": "WRITE_SHIPMENTS",
"status": "Forbidden"
}
}