Skip to main content
POST
/
documents
/
shipping-label
Generate Shipping Label PDF
curl --request POST \
  --url https://staging-api.puppetvendors.com/documents/shipping-label \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "orderId": "<string>",
  "lineItemIds": [
    {}
  ]
}
'
import requests

url = "https://staging-api.puppetvendors.com/documents/shipping-label"

payload = {
"orderId": "<string>",
"lineItemIds": [{}]
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({orderId: '<string>', lineItemIds: [{}]})
};

fetch('https://staging-api.puppetvendors.com/documents/shipping-label', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://staging-api.puppetvendors.com/documents/shipping-label",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'orderId' => '<string>',
'lineItemIds' => [
[

]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://staging-api.puppetvendors.com/documents/shipping-label"

payload := strings.NewReader("{\n \"orderId\": \"<string>\",\n \"lineItemIds\": [\n {}\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://staging-api.puppetvendors.com/documents/shipping-label")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"orderId\": \"<string>\",\n \"lineItemIds\": [\n {}\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://staging-api.puppetvendors.com/documents/shipping-label")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"orderId\": \"<string>\",\n \"lineItemIds\": [\n {}\n ]\n}"

response = http.request(request)
puts response.read_body
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Generate a shipping label PDF for order fulfillment. Returns an S3 URL that expires in 48 hours. Vendor tokens are scoped automatically; merchant tokens must pass vendorId as a query parameter.

Query Parameters

vendorId
string
Vendor ObjectId — required for merchant tokens.

Request Body

orderId
string
required
Order ObjectId.
lineItemIds
array
Optional list of line item ObjectIds to include on the label.

Response

200
{
  "success": true,
  "data": {
    "url": "https://puppetvendors-pdfs.s3.amazonaws.com/labels/...",
    "expiresAt": "2026-04-17T14:22:31Z"
  }
}

Example

curl -X POST "https://staging-api.puppetvendors.com/documents/shipping-label" \
  -H "x-access-token: YOUR_VENDOR_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": "507f1f77bcf86cd799439014",
    "lineItemIds": ["507f1f77bcf86cd799439015"]
  }'