Skip to main content
POST
/
orders
/
invoice
/
grouped
Generate Grouped Invoice by Vendor
curl --request POST \
  --url https://staging-api.puppetvendors.com/orders/invoice/grouped \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "vendorIds": [
    {}
  ],
  "startDate": "<string>",
  "endDate": "<string>"
}
'
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

​
Overview

Generate a consolidated invoice PDF covering all orders from specific vendors within a date range. Useful for monthly or weekly payout summaries. Vendor tokens are automatically scoped to themselves.

​
Request Body

​
vendorIds
array
required
Array of vendor ObjectIds.
​
startDate
string
Include orders from this date (ISO 8601).
​
endDate
string
Include orders until this date (ISO 8601).

​
Response

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

​
Example

curl -X POST "https://staging-api.puppetvendors.com/orders/invoice/grouped" \
  -H "x-access-token: YOUR_VENDOR_JWT" \
  -H "Content-Type: application/json" \
  -d '{
    "vendorIds": ["507f1f77bcf86cd799439011"],
    "startDate": "2026-03-01T00:00:00Z",
    "endDate": "2026-03-31T23:59:59Z"
  }'