Show a shipping label

import { createSellerClient } from '@spree/seller-sdk' const client = createSellerClient({ baseUrl: 'https://your-store.com', jwtToken: 'eyJhbGciOi...', sellerId: 'sel_UkLWZg9DAJ', }) const label = await client.orders.fulfillments.labels.get( 'or_UkLWZg9DAJ', 'ful_UkLWZg9DAJ', 'lbl_UkLWZg9DAJ', )

{ "id": "lbl_UkLWZg9DAJ", "source": "uploaded", "status": "purchased", "carrier": "ups", "carrier_name": "UPS", "service": "Ground", "tracking_number": "1Z879E930346830008", "currency": "USD", "format": "pdf", "external_id": null, "metadata": {}, "refunded_at": null, "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z", "owner_id": "ful_UkLWZg9DAJ", "owner_type": "fulfillment", "cost": "7.25", "integration_id": null, "file_pending": false, "download_url": "/api/v3/seller/orders/or_UkLWZg9DAJ/fulfillments/ful_UkLWZg9DAJ/labels/lbl_UkLWZg9DAJ/download" }

Authorizations

Authorization

string

header

required

JWT token for an authenticated seller session (seller_api audience)

Headers

X-Spree-Seller-Id

string

required

Path Parameters

order_id

string

required

Prefixed order ID

fulfillment_id

string

required

Prefixed fulfillment ID

string

required

Prefixed shipping label ID

Response

200 - application/json

label found

string

required

source

enum<string>

required

Available options:

purchased,

uploaded

status

required

The values listed are the built-in ones; extensions may add more.

Available options:

purchased,

refund_requested,

refunded

carrier

string | null

required

carrier_name

string | null

required

service

string | null

required

tracking_number

string | null

required

currency

enum<string> | null

required

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BYR,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EEK,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LTL,

LVL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MRU,

MTL,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SKK,

SLE,

SLL,

SOS,

SRD,

SSP,

STD,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMM,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYI,

UYU,

UYW,

UZS,

VED,

VEF,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XCG,

XOF,

XPF,

YER,

ZAR,

ZMK,

ZMW,

ZWD,

ZWG,

ZWL,

ZWN,

ZWR

format

enum<string> | null

required

Available options:

pdf,

png,

zpl

external_id

string | null

required

metadata

object

required

refunded_at

string | null

required

created_at

string

required

updated_at

string

required

owner_id

string

required

owner_type

enum<string>

required

Available options:

fulfillment,

return

cost

string

required

integration_id

string | null

required

file_pending

boolean

required

download_url

string | null

required

API basics

Endpoints

Authorizations

Headers

Path Parameters

Response