Skip to main content
POST
Generate Customer Invoice PDF
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

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

Request Body

string
required
Order ObjectId.
string
Optional vendor ObjectId (merchants).

Response

200

Example