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": [
    {}
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://dev.puppetvendors.com/llms.txt

Use this file to discover all available pages before exploring further.

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"]
  }'