---
title: "Create a label"
method: POST
path: "/shipping/{connection_id}/label"
tags: ["shipping", "label"]
---

# Create a label

`POST /shipping/{connection_id}/label`

## Request

- Base URL: `http://api.unified.to`
- URL: `http://api.unified.to/shipping/{connection_id}/label`
- Auth: API key in header `authorization`

## Path parameters

- `connection_id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Request body

- ShippingLabel
  - `id` string: Unique identifier for this label object
  - `created_at` string, date-time: The date that this label object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: The last date that this label object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `shipment_id` string: Reference to the shipment
  - `tracking_number` string: Tracking number for the shipment
  - `label_url` string: URL to download the label
  - `label_format` 'PDF' | 'PNG' | 'ZPL' | 'EPL2' | 'PDF_4X6' | 'PDF_4X8' | 'PNG_4X6' | 'PNG_4X8': Format of the label (PDF, PNG, ZPL, EPL2)
  - `status` 'PENDING' | 'PROCESSING' | 'IN_TRANSIT' | 'DELIVERED' | 'EXCEPTION' | 'CANCELLED' | 'LABEL_CREATED' | 'PICKED_UP' | 'OUT_FOR_DELIVERY' | 'DELIVERY_ATTEMPTED' | 'RETURNED_TO_SENDER' | 'HELD_AT_LOCATION' | 'CUSTOMS_CLEARANCE' | 'EXCEPTION_RESOLVED': Status of the label
  - `is_voided` boolean: Whether label has been voided
  - `label_cost` number: Cost to purchase label
  - `label_cost_currency` string
  - `rate_id` string: Rate used for this label; points to ShippingRate
  - `service_code` string: Service code used
  - `metadata` ShippingMetadata[]
    - `id` string
    - `slug` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
  - `raw` unknown

## Response `200`

Successful

- ShippingLabel
  - `id` string: Unique identifier for this label object
  - `created_at` string, date-time: The date that this label object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: The last date that this label object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `shipment_id` string: Reference to the shipment
  - `tracking_number` string: Tracking number for the shipment
  - `label_url` string: URL to download the label
  - `label_format` 'PDF' | 'PNG' | 'ZPL' | 'EPL2' | 'PDF_4X6' | 'PDF_4X8' | 'PNG_4X6' | 'PNG_4X8': Format of the label (PDF, PNG, ZPL, EPL2)
  - `status` 'PENDING' | 'PROCESSING' | 'IN_TRANSIT' | 'DELIVERED' | 'EXCEPTION' | 'CANCELLED' | 'LABEL_CREATED' | 'PICKED_UP' | 'OUT_FOR_DELIVERY' | 'DELIVERY_ATTEMPTED' | 'RETURNED_TO_SENDER' | 'HELD_AT_LOCATION' | 'CUSTOMS_CLEARANCE' | 'EXCEPTION_RESOLVED': Status of the label
  - `is_voided` boolean: Whether label has been voided
  - `label_cost` number: Cost to purchase label
  - `label_cost_currency` string
  - `rate_id` string: Rate used for this label; points to ShippingRate
  - `service_code` string: Service code used
  - `metadata` ShippingMetadata[]
    - `id` string
    - `slug` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
  - `raw` unknown

---

[API](https://skmtc.dev/unified/apis/unified-to-api-2.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api-2/revisions/7a38bdd7f089?raw)