ShippingShipping labels
Get Many Shipping Labels
Get multiple shipping labels with pagination and filtering
Authorization
api_key x-access-token<token>
In: header
Query Parameters
page?number
Page number for pagination (starting from 0)
Format
doubleDefault
0limit?number
Number of items per page
Format
doubleDefault
20search?string
Search term to filter labels by tracking code, remote ID, or carrier ID
Default
""order_by?string
Field to order results by
Default
"created_at"Value in
- "created_at"
- "updated_at"
- "voided_at"
order?string
Order direction
Value in
- "asc"
- "desc"
scan_status?string
Filter by scan status (comma-separated for multiple)
Default
""shipment_status?string
Filter by shipment status (comma-separated for multiple)
Default
""refund_status?string
Filter by refund status (comma-separated for multiple)
Default
""carrier_id?string
Filter by carrier ID (comma-separated for multiple)
Default
""service_id?string
Filter by service ID (comma-separated for multiple)
Default
""Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/shipos/shipping-labels"{ "data": [ { "formatted_service": "string", "tracking_url": "string", "carrier_correction": { "version": 1, "source_import": { "filename": "string", "import_id": "string" }, "provider": "UPS", "format": "UPS_INVOICE_SUMMARY_V1", "carrier_invoice_number": "string", "carrier_invoice_date": "string", "transaction_date": "string", "confirmed_at": "string", "tracking_number": "string", "correction_type": "string", "correction_reason": "string", "carrier_service_code": "string", "published_amount": 0, "incentive_amount": 0, "original_carrier_cost": 0, "carrier_adjustment_amount": 0.1, "corrected_carrier_cost": 0, "currency": "AED" }, "gaylord_id": "string", "carrier_account_label": "string", "carrier_account_id": "string", "merchant_team_name": "string", "merchant_team_id": "string", "fulfiller_team_name": "string", "fulfiller_team_id": "string", "carrier_integration_type": "GENERIC", "carrier_integration_name": "string", "carrier_integration_id": "string", "shipment_status": "LABEL_PRINTED", "refund_status": "SUBMITTED", "scan_status": "SCANNED", "label_with_packing_slip_url": "string", "original_label_url": "string", "label_url": "string", "tracking_code": "string", "zone": 0, "delivery_date_guaranteed": true, "delivery_date": "2019-08-24T14:15:22Z", "delivery_days": "string", "to_address_name": "string", "to_address_company": "string", "to_address_phone": "string", "to_address_country": "string", "to_address_zip": "string", "to_address_state": "string", "to_address_city": "string", "to_address_street2": "string", "to_address_street1": "string", "from_address_name": "string", "from_address_company": "string", "from_address_phone": "string", "from_address_country": "string", "from_address_zip": "string", "from_address_state": "string", "from_address_city": "string", "from_address_street2": "string", "from_address_street1": "string", "list_currency": "string", "list_rate": 0, "retail_currency": "string", "retail_price": 0, "currency": "string", "price": 0.1, "carrier_id": "string", "service_id": "string", "remote_bukuship_shipment_id": "string", "remote_easypost_tracker_id": "string", "remote_id": "string", "voided_at": "2019-08-24T14:15:22Z", "shipping_label_number": "string", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "id": "string", "rate_selection_details": { "version": 1, "mode": "RATE_SHOP", "fixed_service_selection": "EXACT_RATE", "summary": "string", "selection_timestamp": "string", "selected_because": "CHEAPEST_ELIGIBLE", "rate_shop_id": "string", "rate_shop_name": "string", "requested_rate_label": "string", "deliver_by_date": "string", "deliver_by_business_days_used": 0, "transit_time_restriction": "string", "fallback_transit_time": "string", "service_preference_enabled": true, "preferred_service_label": "string", "preference_threshold_type": "CURRENCY", "preference_threshold": 0, "zone": 0, "selected_rate": { "provider_rate_id": "string", "carrier_account_id": "string", "carrier_account_label": "string", "provider_carrier_account_id": "string", "delivery_date": "string", "delivery_date_guaranteed": true, "currency": "string", "label": "string", "carrier_integration_id": "string", "carrier_integration_type": "GENERIC", "carrier_id": "string", "service_id": "string", "amount": 0, "zone": 0, "estimated_days": 0, "eligible": true, "selected": true, "reasons": [ "string" ] }, "cheapest_eligible_rate": { "provider_rate_id": "string", "carrier_account_id": "string", "carrier_account_label": "string", "provider_carrier_account_id": "string", "delivery_date": "string", "delivery_date_guaranteed": true, "currency": "string", "label": "string", "carrier_integration_id": "string", "carrier_integration_type": "GENERIC", "carrier_id": "string", "service_id": "string", "amount": 0, "zone": 0, "estimated_days": 0, "eligible": true, "selected": true, "reasons": [ "string" ] }, "preference_delta": 0, "eligible_rate_count": 0.1, "excluded_rate_count": 0.1, "evaluated_rates": [ { "provider_rate_id": "string", "carrier_account_id": "string", "carrier_account_label": "string", "provider_carrier_account_id": "string", "delivery_date": "string", "delivery_date_guaranteed": true, "currency": "string", "label": "string", "carrier_integration_id": "string", "carrier_integration_type": "GENERIC", "carrier_id": "string", "service_id": "string", "amount": 0, "zone": 0, "estimated_days": 0, "eligible": true, "selected": true, "reasons": [ "string" ] } ], "selection_steps": [ { "key": "FETCHED_RATES", "detail": "string" } ], "configured_service_levels": { "domestic": [ { "carrier_integration_id": "string", "carrier_integration_name": "string", "carrier_integration_type": "GENERIC", "carrier_id": "string", "service_id": "string", "provider_rate_id": "string", "label": "string" } ], "international": [ { "carrier_integration_id": "string", "carrier_integration_name": "string", "carrier_integration_type": "GENERIC", "carrier_id": "string", "service_id": "string", "provider_rate_id": "string", "label": "string" } ] }, "available_rate_count_by_integration": [ { "carrier_integration_id": "string", "carrier_integration_name": "string", "carrier_integration_type": "GENERIC", "available_rate_count": 0.1 } ], "rate_fetch_errors": [ { "carrier_integration_id": "string", "carrier_integration_name": "string", "carrier_integration_type": "GENERIC", "message": "string" } ], "rate_fetch_decisions": [ { "carrier_integration_id": "string", "carrier_integration_name": "string", "carrier_integration_type": "GENERIC", "decision": "FETCHED", "reason": "ELIGIBLE_CONFIGURED_SERVICES", "provider_called": true, "returned_rate_count": 0.1, "retained_rate_count": 0.1, "service_levels": [ { "carrier_id": "string", "service_id": "string", "shipment_type": "DOMESTIC", "decision": "FETCHED", "reason": "ELIGIBLE_CONFIGURED_SERVICE" } ] } ], "trace_ref": "string" }, "tracking_events": [ { "raw_data": null, "location_country": "string", "location_zip": "string", "location_state": "string", "location_city": "string", "event_code": "string", "event_time": "2019-08-24T14:15:22Z", "status_description": "string", "status_category": "string", "status": "UNKNOWN" } ] } ], "meta": { "page": 0.1, "page_size": 0.1, "has_next_page": true, "has_previous_page": true, "start_index": 0.1, "end_index": 0.1 }}