curl --request POST \
--url https://api.teleship.com/api/shipments/labels \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"serviceCode": "TELESHIP-EXPEDITED-DROPOFF",
"customerReference": "#1001",
"packageType": "parcel",
"shipTo": {
"name": "Fanny Dadin",
"email": "fanny@teleship.com",
"phone": "+1 213-601-6000",
"address": {
"city": "Los Angeles",
"line1": "1300 Eunice Avenue",
"state": "CA",
"country": "US",
"postcode": "90001"
}
},
"shipFrom": {
"name": "London Store",
"address": {
"city": "London",
"line1": "Flat 4, 24 Upper Tachbrook Street",
"state": "England",
"country": "GB",
"postcode": "SW1V 1SW"
},
"company": "TELESHIP LIMITED"
},
"weight": {
"unit": "kg",
"value": 0.48
},
"dimensions": {
"unit": "cm",
"width": 25,
"height": 14,
"length": 35
},
"commodities": [
{
"sku": "stock-1",
"title": "Tetras Small Earrings - One& Only Kea...",
"value": {
"amount": 134,
"currency": "GBP"
},
"quantity": 1,
"unitWeight": {
"unit": "kg",
"value": 0.18
},
"description": "Enjoy these beautiful earrings manufactured in Greece. Worn by Adele and other stars.",
"countryOfOrigin": "GR"
}
],
"metadata": {
"fulfillmentOrderId": "gid://shopify/FulfillmentOrder/7617080492296"
},
"customs": {
"EORI": "GB078617476000",
"contentType": "CommercialGoods",
"invoiceDate": "2026-05-03T20:22:57.027Z",
"invoiceNumber": "#1001"
}
}
'{
"messages": [
{
"code": 123,
"level": "error",
"timestamp": "2024-01-01T00:00:00.00Z",
"message": "An error occurred",
"details": [
"Missing required field"
]
}
],
"shipment": {
"shipmentId": "<string>",
"trackingNumber": "<string>",
"shipDate": "2024-01-01T00:00:00.00Z",
"estimatedDelivery": "2024-01-01T00:00:00.00Z",
"documents": [
{
"format": "PDF",
"url": "https://api.teleship.com/api/shipments/labels/f5233746-71d4-4b05-bf63-56f4abaed5f6/label.pdf",
"base64String": "JVBERi0xLjQKJQlJbTgKMSAwIG9iago8PSplbiAkZwoKCSvQ=="
}
],
"shipTo": {
"name": "<string>",
"address": {
"line1": "",
"city": "",
"postcode": "",
"country": "US"
},
"email": "<string>",
"phone": "<string>",
"company": "<string>"
},
"shipFrom": {
"name": "<string>",
"address": {
"line1": "",
"city": "",
"postcode": "",
"country": "GB"
},
"email": "<string>",
"phone": "<string>",
"company": "<string>"
},
"weight": {
"value": "1.0",
"unit": "kg"
},
"dimensions": {
"length": "40.0",
"width": "30.0",
"height": "16.0",
"unit": "cm"
},
"packageType": "parcel",
"commodities": [
{
"title": "<string>",
"quantity": 1,
"value": {
"amount": "15.0",
"currency": "GBP"
},
"unitWeight": {
"value": "1.0",
"unit": "kg"
},
"description": "<string>",
"hsCode": "<string>",
"predictedHsCode": "<string>",
"predictedTaxCode": "<string>",
"sku": "<string>",
"category": "<string>",
"imageUrl": "<string>",
"productUrl": "<string>",
"productId": "<string>",
"variantId": "<string>",
"compliance": {
"isControlGood": true,
"controlType": "HealthRegulated",
"regulatoryAgency": "FDA",
"regulatoryProgram": "Food Safety",
"regulatoryCategoryCode": "21-CFR-XYZ",
"EIN": "<string>",
"iossNumber": "<string>",
"importLicenseNumber": "<string>",
"certificationType": "CE",
"certificationReference": "CE-DECL-12345"
},
"dutiesAndTaxes": [
"<string>"
],
"metadata": {}
}
],
"customs": {
"invoiceNumber": "<string>",
"invoiceDate": "2023-11-07T05:31:56Z",
"orderId": "<string>",
"orderTotalValue": {
"amount": "15.0",
"currency": "GBP"
},
"certified": true,
"signedBy": "<string>",
"EORI": "<string>",
"IOSS": "<string>",
"VAT": "<string>",
"EIN": "<string>",
"VOECNUMBER": "<string>",
"SWISSVAT": "<string>",
"KAR_VAT": "<string>",
"CA_GST": "<string>",
"AU_GST": "<string>",
"NZ_GST": "<string>",
"JPConsumptionTax": "<string>",
"GPSRContactInfo": "<string>",
"importerOfRecord": {
"name": "<string>",
"address": {
"line1": "",
"city": "",
"postcode": "",
"country": "GB"
},
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"stateTaxId": "<string>",
"countryTaxId": "<string>"
}
},
"rate": {
"price": "10.59",
"currency": "GBP",
"transit": 5,
"estimatedDelivery": "2024-01-01T00:00:00.00Z",
"service": {
"name": "<string>",
"code": "<string>",
"transit": 123,
"checkoutName": "<string>",
"description": "<string>",
"dispatchDays": 1,
"includeFirstMile": false,
"isActive": true,
"config": {
"isPostal": true
},
"id": "<string>"
},
"charges": [
{
"name": "base",
"amount": 22.77,
"currency": "GBP"
},
{
"name": "Duty",
"amount": 1.2,
"currency": "GBP"
},
{
"name": "VAT",
"amount": 0.5,
"currency": "GBP"
}
]
},
"scaleWeight": {
"value": "1.0",
"unit": "kg"
},
"dimWeight": {
"value": "1.0",
"unit": "kg"
},
"billWeight": {
"value": "1.0",
"unit": "kg"
},
"events": [
{
"timestamp": "2023-11-07T05:31:56Z",
"code": "<string>",
"description": "<string>",
"location": "<string>"
}
],
"surcharges": [
{
"id": "<string>",
"type": "<string>",
"name": "<string>",
"amount": 123,
"metadata": {},
"shipmentId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"taxesCollectionId": "<string>"
}
],
"trackingURL": "https://teleship.com/tracking?trackingNumber=1234567890",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"returnTo": {
"name": "<string>",
"address": {
"line1": "",
"city": "",
"postcode": "",
"country": "GB"
},
"email": "<string>",
"phone": "<string>",
"company": "<string>"
},
"billTo": {
"name": "<string>",
"address": {
"line1": "",
"city": "",
"postcode": "",
"country": "GB"
},
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"stateTaxId": "<string>",
"countryTaxId": "<string>"
},
"description": "<string>",
"additionalServices": {
"signatureRequired": true,
"deliveryWarranty": true,
"deliveryPUDO": true,
"lowCarbon": true
},
"actualBillWeight": {
"value": "1.0",
"unit": "kg"
},
"actualScaleWeight": {
"value": "1.0",
"unit": "kg"
},
"actualDimensions": {
"length": "40.0",
"width": "30.0",
"height": "16.0",
"unit": "cm"
},
"customerReference": "<string>",
"commercialInvoiceReference": "<string>",
"metadata": {},
"firstMile": {
"carrier": "<string>",
"trackingNumber": "<string>",
"trackingUrl": "<string>"
},
"lastMile": {
"carrier": "<string>",
"trackingNumber": "<string>",
"trackingUrl": "<string>"
},
"dropOffLocation": {
"name": "<string>",
"address": {
"line1": "",
"city": "",
"postcode": "",
"country": "GB"
},
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"stateTaxId": "<string>",
"countryTaxId": "<string>"
}
}
}{
"messages": [
{
"code": 123,
"level": "error",
"timestamp": "2024-01-01T00:00:00.00Z",
"message": "An error occurred",
"details": [
"Missing required field"
]
}
]
}{
"messages": [
{
"code": 123,
"level": "error",
"timestamp": "2024-01-01T00:00:00.00Z",
"message": "An error occurred",
"details": [
"Missing required field"
]
}
]
}{
"messages": [
{
"code": 123,
"level": "error",
"timestamp": "2024-01-01T00:00:00.00Z",
"message": "An error occurred",
"details": [
"Missing required field"
]
}
]
}{
"messages": [
{
"code": 123,
"level": "error",
"timestamp": "2024-01-01T00:00:00.00Z",
"message": "An error occurred",
"details": [
"Missing required field"
]
}
]
}Shipping services
Create shipping label
Create a shipping label for your shipment, ready for printing and attaching to your package.
What happens:
- Validates your shipment details
- Books the shipment with the selected service
- Returns a label and tracking number
Why use this? Automate label generation for e-commerce orders, warehouse operations, or bulk shipping.
POST
/
api
/
shipments
/
labels
curl --request POST \
--url https://api.teleship.com/api/shipments/labels \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"serviceCode": "TELESHIP-EXPEDITED-DROPOFF",
"customerReference": "#1001",
"packageType": "parcel",
"shipTo": {
"name": "Fanny Dadin",
"email": "fanny@teleship.com",
"phone": "+1 213-601-6000",
"address": {
"city": "Los Angeles",
"line1": "1300 Eunice Avenue",
"state": "CA",
"country": "US",
"postcode": "90001"
}
},
"shipFrom": {
"name": "London Store",
"address": {
"city": "London",
"line1": "Flat 4, 24 Upper Tachbrook Street",
"state": "England",
"country": "GB",
"postcode": "SW1V 1SW"
},
"company": "TELESHIP LIMITED"
},
"weight": {
"unit": "kg",
"value": 0.48
},
"dimensions": {
"unit": "cm",
"width": 25,
"height": 14,
"length": 35
},
"commodities": [
{
"sku": "stock-1",
"title": "Tetras Small Earrings - One& Only Kea...",
"value": {
"amount": 134,
"currency": "GBP"
},
"quantity": 1,
"unitWeight": {
"unit": "kg",
"value": 0.18
},
"description": "Enjoy these beautiful earrings manufactured in Greece. Worn by Adele and other stars.",
"countryOfOrigin": "GR"
}
],
"metadata": {
"fulfillmentOrderId": "gid://shopify/FulfillmentOrder/7617080492296"
},
"customs": {
"EORI": "GB078617476000",
"contentType": "CommercialGoods",
"invoiceDate": "2026-05-03T20:22:57.027Z",
"invoiceNumber": "#1001"
}
}
'{
"messages": [
{
"code": 123,
"level": "error",
"timestamp": "2024-01-01T00:00:00.00Z",
"message": "An error occurred",
"details": [
"Missing required field"
]
}
],
"shipment": {
"shipmentId": "<string>",
"trackingNumber": "<string>",
"shipDate": "2024-01-01T00:00:00.00Z",
"estimatedDelivery": "2024-01-01T00:00:00.00Z",
"documents": [
{
"format": "PDF",
"url": "https://api.teleship.com/api/shipments/labels/f5233746-71d4-4b05-bf63-56f4abaed5f6/label.pdf",
"base64String": "JVBERi0xLjQKJQlJbTgKMSAwIG9iago8PSplbiAkZwoKCSvQ=="
}
],
"shipTo": {
"name": "<string>",
"address": {
"line1": "",
"city": "",
"postcode": "",
"country": "US"
},
"email": "<string>",
"phone": "<string>",
"company": "<string>"
},
"shipFrom": {
"name": "<string>",
"address": {
"line1": "",
"city": "",
"postcode": "",
"country": "GB"
},
"email": "<string>",
"phone": "<string>",
"company": "<string>"
},
"weight": {
"value": "1.0",
"unit": "kg"
},
"dimensions": {
"length": "40.0",
"width": "30.0",
"height": "16.0",
"unit": "cm"
},
"packageType": "parcel",
"commodities": [
{
"title": "<string>",
"quantity": 1,
"value": {
"amount": "15.0",
"currency": "GBP"
},
"unitWeight": {
"value": "1.0",
"unit": "kg"
},
"description": "<string>",
"hsCode": "<string>",
"predictedHsCode": "<string>",
"predictedTaxCode": "<string>",
"sku": "<string>",
"category": "<string>",
"imageUrl": "<string>",
"productUrl": "<string>",
"productId": "<string>",
"variantId": "<string>",
"compliance": {
"isControlGood": true,
"controlType": "HealthRegulated",
"regulatoryAgency": "FDA",
"regulatoryProgram": "Food Safety",
"regulatoryCategoryCode": "21-CFR-XYZ",
"EIN": "<string>",
"iossNumber": "<string>",
"importLicenseNumber": "<string>",
"certificationType": "CE",
"certificationReference": "CE-DECL-12345"
},
"dutiesAndTaxes": [
"<string>"
],
"metadata": {}
}
],
"customs": {
"invoiceNumber": "<string>",
"invoiceDate": "2023-11-07T05:31:56Z",
"orderId": "<string>",
"orderTotalValue": {
"amount": "15.0",
"currency": "GBP"
},
"certified": true,
"signedBy": "<string>",
"EORI": "<string>",
"IOSS": "<string>",
"VAT": "<string>",
"EIN": "<string>",
"VOECNUMBER": "<string>",
"SWISSVAT": "<string>",
"KAR_VAT": "<string>",
"CA_GST": "<string>",
"AU_GST": "<string>",
"NZ_GST": "<string>",
"JPConsumptionTax": "<string>",
"GPSRContactInfo": "<string>",
"importerOfRecord": {
"name": "<string>",
"address": {
"line1": "",
"city": "",
"postcode": "",
"country": "GB"
},
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"stateTaxId": "<string>",
"countryTaxId": "<string>"
}
},
"rate": {
"price": "10.59",
"currency": "GBP",
"transit": 5,
"estimatedDelivery": "2024-01-01T00:00:00.00Z",
"service": {
"name": "<string>",
"code": "<string>",
"transit": 123,
"checkoutName": "<string>",
"description": "<string>",
"dispatchDays": 1,
"includeFirstMile": false,
"isActive": true,
"config": {
"isPostal": true
},
"id": "<string>"
},
"charges": [
{
"name": "base",
"amount": 22.77,
"currency": "GBP"
},
{
"name": "Duty",
"amount": 1.2,
"currency": "GBP"
},
{
"name": "VAT",
"amount": 0.5,
"currency": "GBP"
}
]
},
"scaleWeight": {
"value": "1.0",
"unit": "kg"
},
"dimWeight": {
"value": "1.0",
"unit": "kg"
},
"billWeight": {
"value": "1.0",
"unit": "kg"
},
"events": [
{
"timestamp": "2023-11-07T05:31:56Z",
"code": "<string>",
"description": "<string>",
"location": "<string>"
}
],
"surcharges": [
{
"id": "<string>",
"type": "<string>",
"name": "<string>",
"amount": 123,
"metadata": {},
"shipmentId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"taxesCollectionId": "<string>"
}
],
"trackingURL": "https://teleship.com/tracking?trackingNumber=1234567890",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"returnTo": {
"name": "<string>",
"address": {
"line1": "",
"city": "",
"postcode": "",
"country": "GB"
},
"email": "<string>",
"phone": "<string>",
"company": "<string>"
},
"billTo": {
"name": "<string>",
"address": {
"line1": "",
"city": "",
"postcode": "",
"country": "GB"
},
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"stateTaxId": "<string>",
"countryTaxId": "<string>"
},
"description": "<string>",
"additionalServices": {
"signatureRequired": true,
"deliveryWarranty": true,
"deliveryPUDO": true,
"lowCarbon": true
},
"actualBillWeight": {
"value": "1.0",
"unit": "kg"
},
"actualScaleWeight": {
"value": "1.0",
"unit": "kg"
},
"actualDimensions": {
"length": "40.0",
"width": "30.0",
"height": "16.0",
"unit": "cm"
},
"customerReference": "<string>",
"commercialInvoiceReference": "<string>",
"metadata": {},
"firstMile": {
"carrier": "<string>",
"trackingNumber": "<string>",
"trackingUrl": "<string>"
},
"lastMile": {
"carrier": "<string>",
"trackingNumber": "<string>",
"trackingUrl": "<string>"
},
"dropOffLocation": {
"name": "<string>",
"address": {
"line1": "",
"city": "",
"postcode": "",
"country": "GB"
},
"email": "<string>",
"phone": "<string>",
"company": "<string>",
"stateTaxId": "<string>",
"countryTaxId": "<string>"
}
}
}{
"messages": [
{
"code": 123,
"level": "error",
"timestamp": "2024-01-01T00:00:00.00Z",
"message": "An error occurred",
"details": [
"Missing required field"
]
}
]
}{
"messages": [
{
"code": 123,
"level": "error",
"timestamp": "2024-01-01T00:00:00.00Z",
"message": "An error occurred",
"details": [
"Missing required field"
]
}
]
}{
"messages": [
{
"code": 123,
"level": "error",
"timestamp": "2024-01-01T00:00:00.00Z",
"message": "An error occurred",
"details": [
"Missing required field"
]
}
]
}{
"messages": [
{
"code": 123,
"level": "error",
"timestamp": "2024-01-01T00:00:00.00Z",
"message": "An error occurred",
"details": [
"Missing required field"
]
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The preferred service code name - e.g. TELESHIP-EXPEDITED-DROPOFF
Example:
"TELESHIP-EXPEDITED-DROPOFF"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
envelope, tube, parcel Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The expected pickup/dropoff date. If provided this must be at least one non-holiday, business day in the future
Example:
"2024-01-01T00:00:00.00Z"
List of the parcel's contents for customs purposes. One entry for each item in the parcel.
Show child attributes
Show child attributes
Gives the recipient information about the parcel in tracking emails.
Maximum string length:
100Additional services for the shipment
Show child attributes
Show child attributes
The electronic trade documents to upload
Show child attributes
Show child attributes
The request reference for the shipment
Customer information that will appear on the label. This can be used for pick and pack purposes, to help with parcel identification, or anything else the shipper needs.
Commercial invoice reference
The freight/shipping charge provided by the merchant at checkout. Used for accurate VAT-on-freight calculations and audit trail.
Show child attributes
Show child attributes
Was this page helpful?
⌘I