Skip to main content
POST
/
documents
/
customer-invoice
Generate Customer Invoice PDF
curl --request POST \
  --url https://staging-api.puppetvendors.com/documents/customer-invoice \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "orderId": "<string>",
  "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 customer-facing invoice PDF. Returns an S3 URL that expires in 48 hours. Vendor tokens are scoped automatically. Merchants may omit vendor scope for a shop-level invoice, or pass vendorId via query param and/or body to scope to a vendor. The query parameter takes precedence when both are supplied.

​
Query Parameters

​
vendorId
string
Optional vendor ObjectId (merchants). Takes precedence over body vendorId.

​
Request Body

​
orderId
string
required
Order ObjectId.
​
vendorId
string
Optional vendor ObjectId (merchants).

​
Response

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

​
Example

curl -X POST "https://staging-api.puppetvendors.com/documents/customer-invoice" \
  -H "x-access-token: YOUR_VENDOR_JWT" \
  -H "Content-Type: application/json" \
  -d '{ "orderId": "507f1f77bcf86cd799439014" }'