ShippingShipping labels
Get Shipping Label
Get a single shipping label by ID
Authorization
api_key x-access-token<token>
In: header
Path Parameters
id*string
The shipping label ID
Response Body
application/json
application/problem+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/string"{ "formatted_service": "string", "tracking_url": "string", "carrier_correction": { "version": 1, "source_import": { "filename": "string", "import_id": "string" }, "provider": "EASYPOST", "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_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", "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", "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", "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", "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", "label": "string" } ], "international": [ { "carrier_integration_id": "string", "carrier_integration_name": "string", "carrier_integration_type": "GENERIC", "carrier_id": "string", "service_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" }, "packages": [ { "id": "string", "idempotency_key": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "name": "string", "manifested_at": "2019-08-24T14:15:22Z", "shipped_at": "2019-08-24T14:15:22Z", "status": "PENDING", "packing_slip_url": "string", "measurement_unit": "MM", "type": "FULFILLMENT_ORDER", "length": 0.1, "width": 0.1, "height": 0.1, "weight_unit": "G", "weight": 0.1, "total_customs_value": 0, "config": { "require_pack_shot": true, "show_unfulfilled_items_on_packing_list": true, "show_prices_on_packing_slip": true, "incoterm": "FAS", "incoterm_location": "string", "eel_pfc": "string", "delivery_confirmation": "NO_SIGNATURE", "saturday_delivery": true, "insurance_policy": { "mode": "none" }, "customs_signer": "string", "customs_signer_title": "string", "customs_certify": true, "non_delivery_option": "ABANDON", "restriction_type": "NONE", "restriction_comments": "string", "contents_type": "OTHER", "contents_explanation": "string", "commercial_invoice_transaction_reason": "SALE", "declaration": "string", "commercial_invoice_payment_terms": "string", "commercial_invoice_transport_mode": "string", "commercial_invoice_port_of_entry": "string", "commercial_invoice_country_of_transshipment": "string", "commercial_invoice_package_marks": "string", "commercial_invoice_freight_amount": 0, "commercial_invoice_discount_amount": 0, "commercial_invoice_other_charge_amount": 0, "commercial_invoice_other_charge_description": "string", "commercial_invoice_importer_tax_id": "string", "commercial_invoice_importer_vat": "string", "commercial_invoice_importer_eori": "string", "commercial_invoice_importer_ioss": "string", "commercial_invoice_vat_statement": "string", "commercial_invoice_export_license_number": "string", "destination_control_statement_required": true }, "rate_error_data": { "detailed_errors": [ { "carrier_type": "GENERIC", "message": "string" } ], "available_rates": [ { "currency": "string", "amount": 0.1, "service_name": "string", "carrier_name": "string", "service_id": "string", "carrier_id": "string", "carrier_integration_type": "GENERIC", "carrier_integration_id": "string", "estimated_days": 0, "delivery_date_guaranteed": true, "delivery_date": "string", "provider_rate_id": "string" } ], "message": "string" }, "error_message": "string", "carrier_id": "string", "service_id": "string", "provider_rate_id": "string", "picking_session_id": "string", "fulfillment_order_id": "string", "work_order_id": "string", "return_id": "string", "carton_id": "string", "shipping_label_id": "string", "scan_form_id": "string", "carrier_integration_id": "string", "carrier_integration_name": "string", "carrier_integration_type": "GENERIC", "carton_name": "string", "fulfiller_team_id": "string", "fulfiller_team_name": "string", "bulk_ship_id": "string", "bulk_ship_template_package_id": "string", "warehouse_id": "string", "warehouse_name": "string", "merchant_team_id": "string", "merchant_team_name": "string", "from_address_name": "string", "from_address_company": "string", "from_address_address1": "string", "from_address_address2": "string", "from_address_city": "string", "from_address_state": "string", "from_address_country": "string", "from_address_zip": "string", "from_address_phone": "string", "from_address_email": "string", "to_address_name": "string", "to_address_company": "string", "to_address_address1": "string", "to_address_address2": "string", "to_address_city": "string", "to_address_state": "string", "to_address_country": "string", "to_address_zip": "string", "to_address_phone": "string", "to_address_email": "string", "rate_shop_id": "string", "rate_shop_name": "string", "deliver_by": "2019-08-24T14:15:22Z", "line_item_hash": "string", "total_item_quantity": 0.1, "unique_line_item_count": 0.1, "formatted_service": "string", "shipping_label_tracking_code": "string", "shipping_label_tracking_url": "string", "shipping_label_formatted_service": "string", "shipping_label_url": "string", "shipment_status": "LABEL_PRINTED", "package_line_items": [ { "uom_label": "string", "uom_multiplier_to_eaches": 0, "uom_profile_id": "string", "work_order_line_item_id": "string", "core_fulfillment_order_line_item_id": "string", "printed_commodity_identifier": "string", "eccn": "string", "manufacturer": "string", "hs_code": "string", "country_of_origin": "string", "customs_value_currency": "string", "customs_value": 0, "customs_description": "string", "weight_unit": "G", "weight": 0, "expiration_date": "2019-08-24T14:15:22Z", "lot_code": "string", "package_id": "string", "product_id": "string", "quantity": 0.1, "image_url": "string", "sku": "string", "name": "string", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "id": "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" } ]}