GET
Retrieve a LabelSpec

Authorizations

Authorization
string
header
required

sk_test_ / sk_live_ / rk_test_ / rk_live_ keys

Headers

Shipping-Version
string
Shipping-Account
string

Act on behalf of a connected account (acct_...)

Path Parameters

id
string
required

Query Parameters

expand[]
string[]

Response

OK

id
string
required

Prefixed lspec_

Example:

"lspec_1Q2w3E4r"

object
enum<string>
required
Available options:
label_spec
livemode
boolean
required
created
integer<unix-time>
required

Unix timestamp (seconds)

carrier
string
required
template
string
required
status
enum<string>
required
Available options:
draft,
active,
retired
updated
integer<unix-time>

Unix timestamp (seconds)

owner
string
services
string[]
sizes
string[]
dpi
integer[]
required_fields
string[]
barcodes
object[]
zones
object[]
tracking_numbers
object
certification
object
version
integer
user_metadata
object

Client-writable. Up to 50 string key/value pairs. Never sent to carriers.

carrier_metadata
object
read-only

Read-only. Carrier-returned data not modelled by the spec (routing codes, internal IDs). Untrusted and unversioned; keys may change with the carrier's API.

system_metadata
object
read-only

Read-only. Implementer provenance. Implementer-specific keys are prefixed x_.