List shipments
List paginated shipments for the current user, optionally filtered by status, brand, carrier or the period they were created in.
Authorization
authorization In: header
Query Parameters
Filter by one or more shipment statuses, comma-separated (e.g. statuses=DELIVERED,IN_TRANSIT).
Filter by shipping label tracking code prefix
Sort direction by creation time (created_at). Defaults to desc.
"asc" | "desc"Filter by one or more merchant brands, comma-separated (e.g. brands=Highline,Amphora).
Filter by one or more carriers, comma-separated (e.g. carriers=UniUni,GoFo). Matches the carrier the shipment's purchased label is on, not every carrier it was quoted by.
Start date (inclusive, ISO 8601). Only shipments created on or after this date.
dateEnd date (inclusive, ISO 8601). Only shipments created on or before this date.
datePage number
Page size
Response Body
application/json
application/json
curl -X GET "https://api.parsel.app/shipments?page=1&page_size=10"{
"data": [
{
"created_at": {},
"custom_reference_1": "Custom Reference 1",
"custom_reference_2": "Custom Reference 2",
"customs_info": {
"customs_items": [
{
"description": "Cotton T-shirt",
"harmonized_system_code": "6109.10.00",
"origin_country": "US",
"quantity": 3,
"value": 10,
"weight": 5,
"weight_unit": "OZ"
}
],
"customs_signer": "Steve Brule",
"incoterm": "DAP"
},
"destination": {
"city": "Anytown",
"company": "Acme Inc.",
"country": "US",
"email": "jane.doe@example.com",
"name": "Jane Doe",
"phone": "+1234567890",
"state": "CA",
"street1": "123 Main St",
"zip": "12345"
},
"id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
"origin": {
"city": "Anytown",
"company": "Acme Inc.",
"country": "US",
"email": "john.doe@example.com",
"name": "John Doe",
"phone": "+1234567890",
"state": "CA",
"street1": "123 Main St",
"zip": "12345"
},
"parcel": {
"height": 10,
"length": 10,
"length_unit": "IN",
"weight": 10,
"weight_unit": "OZ",
"width": 10
},
"shipping_rates": [
{
"carrier": "UPS",
"estimated_delivery_date": {},
"estimated_delivery_days": 3,
"id": "123e4567-e89b-12d3-a456-426614174000",
"price": {
"amount": 10,
"currency": "USD"
},
"service": "Ground",
"rate_metadata": {
"billable_weight": 12,
"surcharge_metadata": {
"surcharge": {
"amount": 2.5,
"currency": "USD"
},
"surcharge_type": "DAS"
},
"surcharges_metadata": [
{
"surcharge": {
"amount": 2.5,
"currency": "USD"
},
"surcharge_type": "DAS"
},
{
"surcharge": {
"amount": 35,
"currency": "USD"
},
"surcharge_type": "HANDLING"
}
],
"usps_zone": 5,
"weight_metadata": {
"actual_oz_weight": 10,
"billable_oz_weight": 12,
"dim_factor": 166,
"dim_threshold": 1728,
"volume": 1000
}
}
},
{
"carrier": "USPS",
"estimated_delivery_date": {},
"estimated_delivery_days": 10,
"id": "123e4567-e89b-12d3-a456-426614174001",
"price": {
"amount": 10,
"currency": "USD"
},
"service": "GroundAdvantage",
"rate_metadata": {
"billable_weight": 12,
"surcharge_metadata": {
"surcharge": {
"amount": 2.5,
"currency": "USD"
},
"surcharge_type": "DAS"
},
"surcharges_metadata": [
{
"surcharge": {
"amount": 2.5,
"currency": "USD"
},
"surcharge_type": "DAS"
},
{
"surcharge": {
"amount": 35,
"currency": "USD"
},
"surcharge_type": "HANDLING"
}
],
"usps_zone": 5,
"weight_metadata": {
"actual_oz_weight": 10,
"billable_oz_weight": 12,
"dim_factor": 166,
"dim_threshold": 1728,
"volume": 1000
}
}
}
],
"status": "OPEN",
"updated_at": {},
"zone": 1
}
],
"metadata": {
"current_page": 1,
"page_size": 25,
"total_count": 87,
"total_pages": 4
}
}{
"errors": {
"message": "This action requires the WRITE_SHIPMENTS scope",
"required_scope": "WRITE_SHIPMENTS",
"status": "Forbidden"
}
}