> ## Documentation Index > Fetch the complete documentation index at: https://developers.teleship.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve shipping details > Retrieve detailed information about a specific shipment, including: - Tracking status and history - Estimated and actual delivery dates - Downloadable shipping documents (labels, invoices) - Service and package details **Use this endpoint to:** Display shipment progress to customers or for internal tracking and auditing. ## OpenAPI ````yaml /api-reference/openapi.json get /api/shipments/labels/{shipmentId} openapi: 3.0.0 info: title: Teleship description: > Teleship is a leading cross-border logistics provider offering seamless global commerce solutions through our comprehensive API. With Teleship's API, developers can integrate our cross-border shipping services, trade engine, and logistics solutions directly into their applications. **Key Features:** - Cross-border shipping solutions for international commerce - Real-time shipping rates and delivery estimates - End-to-end shipment tracking with detailed status updates - Automated customs compliance and product classification - Real-time event notifications through webhooks **Why Teleship?** - API-first: Developer-friendly integration with comprehensive documentation - Enterprise-ready: Built for businesses of all sizes - Secure: Enterprise-grade security and compliance - Integrated: Seamless connection with e-commerce, ERP, and fulfillment systems Start shipping globally with Teleship's powerful cross-border logistics API. version: 1.0.0 contact: {} servers: - url: https://api.teleship.com security: [] tags: [] paths: /api/shipments/labels/{shipmentId}: get: tags: - Shipping Services summary: Retrieve shipping details description: >- Retrieve detailed information about a specific shipment, including: - Tracking status and history - Estimated and actual delivery dates - Downloadable shipping documents (labels, invoices) - Service and package details **Use this endpoint to:** Display shipment progress to customers or for internal tracking and auditing. operationId: getShippingDetails parameters: - name: shipmentId required: true in: path schema: type: string - name: x-account-id in: header required: false schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ShippingLabelDto' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ResponseMessagesDto' '404': description: Shipment not found content: application/json: schema: $ref: '#/components/schemas/ResponseMessagesDto' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ResponseMessagesDto' security: - bearer: [] components: schemas: ShippingLabelDto: type: object properties: messages: type: array items: $ref: '#/components/schemas/ErrorResponseDto' shipment: $ref: '#/components/schemas/ShipmentDto' required: - messages ResponseMessagesDto: type: object properties: messages: type: array items: $ref: '#/components/schemas/ErrorResponseDto' required: - messages ErrorResponseDto: type: object properties: code: type: number level: type: string enum: - error - warning - info example: error description: Error level default: error timestamp: format: date-time type: string example: '2024-01-01T00:00:00.00Z' message: type: string example: An error occurred details: example: - Missing required field type: array items: type: string required: - code - level - timestamp - message - details ShipmentDto: type: object properties: shipmentId: type: string description: >- The shipment's unique identifier (UUID) in Teleship's system. This value is used by the API. trackingNumber: type: string description: The shipment's tracking number. status: type: string enum: - label_created - created - alert - picked_up - in_transit - delivered - cancelled - delayed - discarded - delivery_event - return_to_sender - terminated - failed shipDate: type: string description: >- The expected pickup/dropoff date. If provided this must be at least one non-holiday, business day in the future format: date-time example: '2024-01-01T00:00:00.00Z' default: '2026-05-03T20:22:57.010Z' estimatedDelivery: type: string description: >- The expected delivery date for the shipment. If provided this must be at least one non-holiday, business day in the future format: date-time example: '2024-01-01T00:00:00.00Z' documents: description: >- The shipping labels of different sizes and format created for the shipment. type: array items: $ref: '#/components/schemas/DocumentDto' shipTo: $ref: '#/components/schemas/DestinationDto' shipFrom: $ref: '#/components/schemas/OriginDto' returnTo: $ref: '#/components/schemas/OriginDto' billTo: $ref: '#/components/schemas/LocationDto' weight: description: The gross weight of the package. allOf: - $ref: '#/components/schemas/WeightDto' dimensions: $ref: '#/components/schemas/DimensionsDto' packageType: type: string description: The packaging type for the shipment enum: - envelope - tube - parcel default: parcel description: type: string commodities: type: array items: $ref: '#/components/schemas/CommodityDto' customs: description: Customs declaration details for the shipment allOf: - $ref: '#/components/schemas/CustomsDto' additionalServices: description: Additional services for the shipment allOf: - $ref: '#/components/schemas/AdditionalServiceDto' rate: $ref: '#/components/schemas/RateDto' scaleWeight: $ref: '#/components/schemas/WeightDto' dimWeight: $ref: '#/components/schemas/WeightDto' billWeight: $ref: '#/components/schemas/WeightDto' actualBillWeight: $ref: '#/components/schemas/WeightDto' actualScaleWeight: $ref: '#/components/schemas/WeightDto' actualDimensions: $ref: '#/components/schemas/DimensionsDto' customerReference: type: string commercialInvoiceReference: type: string metadata: type: object firstMile: $ref: '#/components/schemas/TrackingCarrierDto' lastMile: $ref: '#/components/schemas/TrackingCarrierDto' dropOffLocation: $ref: '#/components/schemas/LocationDto' events: type: array items: $ref: '#/components/schemas/TrackingEventDto' surcharges: type: array items: $ref: '#/components/schemas/SurchargeEntity' trackingURL: type: string description: tracking URL for the shipment example: https://teleship.com/tracking?trackingNumber=1234567890 createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - shipmentId - trackingNumber - status - shipDate - estimatedDelivery - documents - shipTo - shipFrom - weight - dimensions - packageType - commodities - customs - rate - scaleWeight - dimWeight - billWeight - events - surcharges - trackingURL - createdAt - updatedAt DocumentDto: type: object properties: type: type: string enum: - LABEL - INVOICE - PACKING_SLIP format: type: string enum: - PDF - ZPL - PNG default: PDF url: type: string example: >- https://api.teleship.com/api/shipments/labels/f5233746-71d4-4b05-bf63-56f4abaed5f6/label.pdf base64String: type: string example: JVBERi0xLjQKJQlJbTgKMSAwIG9iago8PSplbiAkZwoKCSvQ== required: - type - format - url - base64String DestinationDto: type: object properties: name: type: string description: The recipient's name. email: type: string description: Email address for the recipient. phone: type: string description: >- Phone number for the recipient. A valid local phone number including area code or a fully qualified international number. Drivers can use this to coordinate pickup with the sender. company: type: string description: >- Business name. This helps the driver successfully collect and deliver the parcel. address: description: The destination address for the shipment default: line1: '' city: '' postcode: '' country: US allOf: - $ref: '#/components/schemas/DestinationAddressDto' required: - name - address OriginDto: type: object properties: name: type: string description: The shipper's name. email: type: string description: Email address for the shipper. phone: type: string description: >- Phone number for the shipper. A valid local phone number including area code or a fully qualified international number. Drivers can use this to coordinate pickup with the sender. company: type: string description: >- Business name. This helps the driver successfully collect and deliver the parcel. address: description: The origin address for the shipment default: line1: '' city: '' postcode: '' country: GB allOf: - $ref: '#/components/schemas/OriginAddressDto' required: - name - address LocationDto: type: object properties: name: type: string description: The shipper's name. email: type: string description: Email address for the shipper. phone: type: string description: >- Phone number for the shipper. A valid local phone number including area code or a fully qualified international number. Drivers can use this to coordinate pickup with the sender. company: type: string description: >- Business name. This helps the driver successfully collect and deliver the parcel. stateTaxId: type: string description: The state tax Id countryTaxId: type: string description: The country tax Id. EORI number for GB, EIN number for US address: default: line1: '' city: '' postcode: '' country: GB allOf: - $ref: '#/components/schemas/AddressDto' required: - name - address WeightDto: type: object properties: value: type: number description: The decimal value of the item weight. default: '1.0' minimum: 0.001 unit: type: string description: The unit of measurement for the weight enum: - kg - lb default: kg required: - value - unit DimensionsDto: type: object properties: length: type: number description: The decimal value of the length of the item default: '40.0' width: type: number description: The decimal value of the width of the item default: '30.0' height: type: number description: The decimal value of the height of the item default: '16.0' unit: type: string description: The unit of measurement for the dimensions enum: - cm - in default: cm required: - length - width - height - unit CommodityDto: type: object properties: title: type: string description: Short name or title of the item. maxLength: 250 description: type: string description: Detailed description of the contents for customs purposes. maxLength: 250 hsCode: type: string description: >- A Harmonized System code for this item, appropriate for the destination country. Single HS tarrif code only. Must be a valid HS code format of 6–10 digits. predictedHsCode: type: string description: The updated HS code after classification. predictedTaxCode: type: string description: The predicted tax code for the item. sku: type: string description: The SKU of the item. maxLength: 50 quantity: type: number description: How many of this item are in the parcel? Must be a whole number. default: 1 value: description: The monetary value of the item. allOf: - $ref: '#/components/schemas/AmountDto' unitWeight: description: >- The weight of a single item. Note we will get a total weight from the quantity and unit weight. allOf: - $ref: '#/components/schemas/WeightDto' countryOfOrigin: type: string description: The country where the goods were manufactured. enum: - AF - AL - DZ - AS - AC - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - EL - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - AN - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW category: type: string description: The category of the item. imageUrl: type: string description: The URL of the product image. productUrl: type: string description: The URL of the product page. productId: type: string description: The product ID of the item. variantId: type: string description: The variant ID of the item. compliance: description: The advanced details of the commodity. allOf: - $ref: '#/components/schemas/CommodityComplianceDto' dutiesAndTaxes: description: The duties and taxes of the commodity. type: array items: type: string metadata: type: object additionalProperties: true description: Metadata about the commodity. default: {} required: - title - quantity - value - unitWeight CustomsDto: type: object properties: contentType: type: string description: The description of the contents for customs purposes. enum: - Documents - Gift - Sample - Other - CommercialGoods - ReturnOfGoods incoterms: type: string description: The incoterms for the shipment. enum: - DDP - DDU invoiceNumber: type: string description: The invoice number for the shipment. invoiceDate: format: date-time type: string description: The date of the invoice. orderId: type: string description: The order ID of the shipment orderTotalValue: description: The total value of the invoice. allOf: - $ref: '#/components/schemas/AmountDto' certified: type: boolean description: Whether the contents are cerified. signedBy: type: string description: The name of the person who certifies the customs content. EORI: type: string description: The EORI number of the seller. IOSS: type: string description: The IOSS number of the seller. VAT: type: string description: The VAT number of the seller. EIN: type: string description: The EIN number of the seller. VOECNUMBER: type: string description: The Norwegian VAT number of the seller. SWISSVAT: type: string description: The Swiss VAT number of the seller. KAR_VAT: type: string description: K number of the seller. CA_GST: type: string description: Canadian GST number of the seller. AU_GST: type: string description: Australian GST number of the seller. NZ_GST: type: string description: New Zealand GST number of the seller. JPConsumptionTax: type: string description: The Swiss VAT number of the seller. GPSRContactInfo: type: string description: The contact information for the GPSR. importerOfRecord: description: The importer of record. allOf: - $ref: '#/components/schemas/LocationDto' required: - contentType AdditionalServiceDto: type: object properties: signatureRequired: type: boolean description: Whether the package is signature required. fees may apply. deliveryWarranty: type: boolean description: The delivery warranty. fees may apply. deliveryPUDO: type: boolean description: The delivery PUDO. fees may apply. lowCarbon: type: boolean description: The low carbon. fees may apply. dutyTaxCalculation: type: string description: The duty tax calculation. enum: - DUTY_TAX_GUARANTEE - DUTY_TAX_CONSIGNEE_COLLECTION RateDto: type: object properties: price: type: number description: The amount charged. example: '10.59' currency: type: string description: The currency of the rate. enum: - GBP - USD - EUR - CAD - AUD - BGN - CZK - DKK - HUF - PLN - RON - SEK - NZD - SAR - AED - HKD - SGD example: GBP transit: type: number description: The transit time in days. example: 5 estimatedDelivery: format: date-time type: string description: The estimated delivery date of the rate. example: '2024-01-01T00:00:00.00Z' service: description: The shipping service being used. allOf: - $ref: '#/components/schemas/ServiceDto' charges: description: >- Breakdowns of the components of the price. These items summed equal the total price. example: - name: base amount: 22.77 currency: GBP - name: Duty amount: 1.2 currency: GBP - name: VAT amount: 0.5 currency: GBP type: array items: $ref: '#/components/schemas/ChargeDto' required: - price - currency - transit - estimatedDelivery - service - charges TrackingCarrierDto: type: object properties: carrier: type: string trackingNumber: type: string trackingUrl: type: string required: - carrier - trackingNumber TrackingEventDto: type: object properties: timestamp: format: date-time type: string code: type: string description: type: string location: type: string required: - timestamp - code SurchargeEntity: type: object properties: id: type: string type: type: string name: type: string amount: type: number currency: type: string enum: - GBP - USD - EUR - CAD - AUD - BGN - CZK - DKK - HUF - PLN - RON - SEK - NZD - SAR - AED - HKD - SGD metadata: type: object shipmentId: type: string taxesCollectionId: type: string description: Optional reference to a TaxesCollection updatedAt: format: date-time type: string createdAt: format: date-time type: string required: - id - type - name - amount - currency - metadata - shipmentId - updatedAt - createdAt DestinationAddressDto: type: object properties: line1: type: string description: >- The street address for the location. Do not include the postcode, state, or suburb in this field. line2: type: string description: Second line of the street address for the location. city: type: string description: >- City or town of the location. In certain regions the name here is validated against the postcode, so must be valid and match. state: type: string description: State, province, or territory of the location. postcode: type: string description: Postcode, postal code, or ZIP code of the location. isResidential: type: boolean description: Whether the address is residential. country: type: string description: The country of destination for the shipment enum: - US - GB - CA - AU - AT - BE - BG - HR - CY - CZ - DK - EE - FI - FR - DE - GR - HU - IE - IT - LV - LT - LU - MT - NL - PL - PT - RO - SI - SK - ES - SE - CH - IS - LI - 'NO' - NZ - SG - HK - AE - SA required: - line1 - country OriginAddressDto: type: object properties: line1: type: string description: >- The street address for the location. Do not include the postcode, state, or suburb in this field. line2: type: string description: Second line of the street address for the location. city: type: string description: >- City or town of the location. In certain regions the name here is validated against the postcode, so must be valid and match. state: type: string description: State, province, or territory of the location. postcode: type: string description: Postcode, postal code, or ZIP code of the location. isResidential: type: boolean description: Whether the address is residential. country: type: string description: The country of origin for the shipment enum: - GB - US - AT - BE - DE - ES - FR - IT - LU - NL required: - line1 - country AddressDto: type: object properties: line1: type: string description: >- The street address for the location. Do not include the postcode, state, or suburb in this field. line2: type: string description: Second line of the street address for the location. city: type: string description: >- City or town of the location. In certain regions the name here is validated against the postcode, so must be valid and match. state: type: string description: State, province, or territory of the location. country: type: string description: Country for the recipient. enum: - AF - AL - DZ - AS - AC - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CY - CZ - DK - DJ - DM - DO - EC - EG - EL - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - AN - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - SH - KN - LC - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SK - SI - SB - SO - ZA - GS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - US - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW postcode: type: string description: Postcode, postal code, or ZIP code of the location. isResidential: type: boolean description: Whether the address is residential. required: - line1 - country AmountDto: type: object properties: amount: type: number description: A decimal value. example: '15.0' currency: type: string description: The currency of the amount. enum: - GBP - USD - EUR - CAD - AUD - BGN - CZK - DKK - HUF - PLN - RON - SEK - NZD - SAR - AED - HKD - SGD default: GBP required: - amount - currency CommodityComplianceDto: type: object properties: isControlGood: type: boolean description: Whether the commodity is controlled. controlType: type: string description: The type of control for the commodity. example: HealthRegulated regulatoryAgency: type: string description: The regulatory agencies for the commodity. example: FDA regulatoryProgram: type: string description: The regulatory program for the commodity. example: Food Safety regulatoryCategoryCode: type: string description: The regulatory category code for the commodity. example: 21-CFR-XYZ EIN: type: string description: The EIN of the seller. iossNumber: type: string description: The IOSS number of the seller. importLicenseNumber: type: string description: The license number of the seller. certificationType: type: string description: The certification type for the commodity. example: CE certificationReference: type: string description: The certificate number of the seller. example: CE-DECL-12345 ServiceDto: type: object properties: name: type: string description: The name of the service checkoutName: type: string description: The checkout display name for the service code: type: string description: The code of the service description: type: string description: The description of the service transit: type: number description: The transit time of the service dispatchDays: type: number description: The number of days it takes to dispatch the shipment default: 1 includeFirstMile: type: boolean description: Whether to include the first mile in the service default: false isActive: type: boolean description: Whether the service is active default: true config: type: object description: >- Service configuration options (JSON). Used for service-specific settings like postal duty calculation. example: isPostal: true id: type: string required: - name - code - transit ChargeDto: type: object properties: amount: type: number description: A decimal value. example: '15.0' currency: type: string description: The currency of the amount. enum: - GBP - USD - EUR - CAD - AUD - BGN - CZK - DKK - HUF - PLN - RON - SEK - NZD - SAR - AED - HKD - SGD default: GBP name: type: string description: The name of the charge. rate: type: number description: The rate of the charge (for VAT and duty charges). code: type: string description: The code of the charge. required: - name securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ````