Retrieve label metadata and download URL

GET/v1/labels/{label_id}Retrieve label metadata and download URL

Parameters

label_idstringpathrequired

pattern ^lbl_[a-z0-9]{20}$

Responses

objectLabel

download_urlstring · urirequired

expires_atstring · date-timerequired

formatstringrequired

one of "pdf", "png", "zpl"

idstringrequired

objectvaluerequired

const "label"

priceobjectrequired

Show child attributes

amountstringrequired

pattern ^[0-9]+(\.[0-9]{2})$

currencystringrequired

pattern ^[A-Z]{3}$

shipment_idstringrequired

Example response

{
  "download_url": "https://downloads.parcel-events.example/labels/synthetic-label.pdf",
  "expires_at": "2026-06-09T00:00:00Z",
  "format": "pdf",
  "id": "lbl_00000000000000000001",
  "object": "label",
  "price": {
    "amount": "12.50",
    "currency": "XTS"
  },
  "shipment_id": "shp_00000000000000000001"
}

objectProblem

detailstring

errorsarray of object

Show child attributes

Show array items

messagestringrequired

pathstringrequired

request_idstringrequired

statusintegerrequired

maximum 599 · minimum 400

titlestringrequired

typestring · urirequired

Example response

{
  "request_id": "req_00000000000000000004",
  "status": 404,
  "title": "Synthetic resource was not found",
  "type": "https://parcel-events.example/problems/not-found"
}

Examples

label_idrequiredpath parameter

curl -X GET 'https://api.parcel-events.example/v1/labels/string'

const response = await fetch('https://api.parcel-events.example/v1/labels/string', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.parcel-events.example/v1/labels/string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.parcel-events.example/v1/labels/string")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.parcel-events.example/v1/labels/string", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.parcel-events.example/v1/labels/string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.parcel-events.example/v1/labels/string"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.parcel-events.example/v1/labels/string")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.parcel-events.example/v1/labels/string");
using var response = await client.SendAsync(request);

{
  "download_url": "https://downloads.parcel-events.example/labels/synthetic-label.pdf",
  "expires_at": "2026-06-09T00:00:00Z",
  "format": "pdf",
  "id": "lbl_00000000000000000001",
  "object": "label",
  "price": {
    "amount": "12.50",
    "currency": "XTS"
  },
  "shipment_id": "shp_00000000000000000001"
}

{
  "request_id": "req_00000000000000000004",
  "status": 404,
  "title": "Synthetic resource was not found",
  "type": "https://parcel-events.example/problems/not-found"
}

Search documentation

Parameters

Responses

Documentation menu