Create Shipping Label
Generate a new shipping label via UPS logistics.
POST
/api/v1/shipping/label/createDescription
Creates a shipping label. Accepts flat address fields or structured object_app / object_ship_from / object_other payloads.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <access_token> | Yes |
| Content-Type | application/json | Yes |
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| address_line_1 | string | Yes | Ship-from street (or use object_app). |
| city | string | Yes | City. |
| state | string | Yes | State. |
| zip | string | Yes | Postal code. |
| country | string | No | Country code (default US). |
| length | number | Yes | Package length (inches). |
| width | number | Yes | Package width (inches). |
| height | number | Yes | Package height (inches). |
| lbs | number | No | Weight pounds. |
| oz | number | No | Weight ounces. |
| first_name | string | No | Sender first name. |
| last_name | string | No | Sender last name. |
| phone | string | No | Contact phone. |
| label_count | number | No | Number of labels (default 1). |
| label_to_contacts | number | No | 1 to email label to contacts. |
| label_to_me | number | No | 1 to email label to requester. |
Example Request Body
{
"address_line_1": "100 Main St",
"city": "Austin",
"state": "TX",
"zip": "78701",
"country": "US",
"length": 12,
"width": 10,
"height": 4,
"lbs": 2,
"oz": 0,
"first_name": "Jane",
"last_name": "Smith",
"phone": "5551234567",
"label_count": 1
}Response
| Field | Type | Description |
|---|---|---|
| message | string | Human-readable confirmation. |
| shipping_label_id | string | Opaque label record ID. |
| tracking_numbers | array | Carrier tracking numbers. |
| files | object | Generated label file paths and URLs. |
| files.label_path | string | Server path to merged PDF. |
| files.label_url | string | Download URL for merged PDF. |
| files.label_file_name | string | Merged PDF filename. |
Related Endpoints
Did this page help you?
Request
curl -X POST https://uat.unduit.com/api-exposed/api/v1/shipping/label/create \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"address_line_1": "100 Main St",
"city": "Austin",
"state": "TX",
"zip": "78701",
"country": "US",
"length": 12,
"width": 10,
"height": 4,
"lbs": 2,
"oz": 0,
"first_name": "Jane",
"last_name": "Smith",
"phone": "5551234567",
"label_count": 1
}'Success Response
{
"message": "Label has been successfully created.",
"shipping_label_id": "3659204-9876",
"tracking_numbers": ["1Z999AA10123456784"],
"files": {
"label_path": "assets/uploads/shipstationlabels/merge/4829174123456789.pdf",
"label_url": "https://uat.unduit.com/api-exposed/show-my-file?path=assets/uploads/shipstationlabels/merge/&filename=4829174123456789.pdf&is_encrypted=1",
"label_file_name": "4829174123456789.pdf"
}
}