WinShopAPI docs
ReferenceDocuments

Get any document as PDF

Renders the document identified by `documentType` and `documentId` with its configured print template and returns `application/pdf` inline. Equivalent to the `/pdf` endpoint on each document type's own controller, for callers that hold the document type as data. 404 when the document has no printable output.

GET
/api/documents/pdf

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Query Parameters

documentType?string
Value in"OrderInternal""Invoice""WriteOff""OrderSupplier""OrderInternet""Intake""ClaimInternal""CommissionIntake""PosReceipt""ClaimCustomer""OrderCustomer""DeliveryNote""ClaimSupplier""InternalTransfer"
documentId?integer
Formatint64

Response Body

response?unknownapplication/octet-stream
curl -X GET 'https://<your-instance>/api/documents/pdf' \  -H 'Authorization: Bearer <access-token>'
null

Get a supplier order as PDF GET

Renders the supplier order with its configured print template and returns `application/pdf` inline. 404 when the document has no printable output. Requires `Permissions.OrderSupplier.View`.

Receipt

Next Page