Buy and render a shipping label

POST/v1/labelsBuy and render a shipping label

Parameters

Idempotency-Keystring · uuidheaderrequired

Request body

required

application/json

objectCreateLabelRequest

formatstringrequired

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

page_sizestring

one of "a4", "letter", "four_by_six" · default "four_by_six"

shipment_idstringrequired

Example request

{
  "format": "pdf",
  "page_size": "four_by_six",
  "shipment_id": "shp_00000000000000000001"
}

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_00000000000000000003",
  "status": 402,
  "title": "Synthetic balance is insufficient",
  "type": "https://parcel-events.example/problems/payment-required"
}

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

{
  "errors": [
    {
      "message": "must be a synthetic postal code",
      "path": "recipient.postal_code"
    }
  ],
  "request_id": "req_00000000000000000006",
  "status": 422,
  "title": "Synthetic request validation failed",
  "type": "https://parcel-events.example/problems/validation"
}

Examples

Idempotency-Keyrequiredheader parameter

curl -X POST 'https://api.parcel-events.example/v1/labels' \
  -H 'Content-Type: application/json' \
  -d '{"format":"pdf","page_size":"four_by_six","shipment_id":"shp_00000000000000000001"}'

const response = await fetch('https://api.parcel-events.example/v1/labels', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"format":"pdf","page_size":"four_by_six","shipment_id":"shp_00000000000000000001"}),
});
const data = await response.json();

const response = await fetch('https://api.parcel-events.example/v1/labels', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"format\":\"pdf\",\"page_size\":\"four_by_six\",\"shipment_id\":\"shp_00000000000000000001\"}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.parcel-events.example/v1/labels",
    headers={"Content-Type": "application/json"},
    data='{"format":"pdf","page_size":"four_by_six","shipment_id":"shp_00000000000000000001"}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"format":"pdf","page_size":"four_by_six","shipment_id":"shp_00000000000000000001"}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.parcel-events.example/v1/labels", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	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");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"format\":\"pdf\",\"page_size\":\"four_by_six\",\"shipment_id\":\"shp_00000000000000000001\"}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.parcel-events.example/v1/labels"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"format\":\"pdf\",\"page_size\":\"four_by_six\",\"shipment_id\":\"shp_00000000000000000001\"}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.parcel-events.example/v1/labels")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"format\":\"pdf\",\"page_size\":\"four_by_six\",\"shipment_id\":\"shp_00000000000000000001\"}"
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.Post, "https://api.parcel-events.example/v1/labels");
request.Content = new StringContent("{\"format\":\"pdf\",\"page_size\":\"four_by_six\",\"shipment_id\":\"shp_00000000000000000001\"}", Encoding.UTF8, "application/json");
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_00000000000000000003",
  "status": 402,
  "title": "Synthetic balance is insufficient",
  "type": "https://parcel-events.example/problems/payment-required"
}

{
  "errors": [
    {
      "message": "must be a synthetic postal code",
      "path": "recipient.postal_code"
    }
  ],
  "request_id": "req_00000000000000000006",
  "status": 422,
  "title": "Synthetic request validation failed",
  "type": "https://parcel-events.example/problems/validation"
}

Search documentation

Parameters

Request body

Responses

Documentation menu