Skip to main content
POST
/
shipping
/
generate-label
Generate Generic Label
curl --request POST \
  --url https://staging-api.puppetvendors.com/shipping/generate-label \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "vendorId": "<string>"
}
'

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 generic shipping label PDF without purchasing a rate from a carrier. Useful for vendors who arrange their own shipping and need a printable label for the package.

Use Cases

  • Generate labels for self-shipped orders
  • Print labels for local delivery or courier pickup
  • Create labels when using a carrier not integrated with the platform

Request Body

vendorId
string
required
The vendor’s ID.
Additional fields are passed through to the label generator (e.g. order details, addresses). The exact fields depend on the shop’s label template configuration.

Response

200
{
  "success": true,
  "data": {
    "labelUrl": "https://cdn.puppetvendors.com/labels/label_abc123.pdf"
  }
}

Example

curl -X POST "https://staging-api.puppetvendors.com/shipping/generate-label" \
  -H "x-access-token: YOUR_VENDOR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "vendorId": "507f1f77bcf86cd799439011"
  }'