Skip to main content
POST
Pdf Sales Order

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowAuthorization Code
Authorization URL
https://auth.jtl-cloud.com/oauth2/auth
Token URL
https://auth.jtl-cloud.com/oauth2/token
Scopes1
salesorders.read
Grants permission to read sales orders.

Headers

x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

salesOrderId
string<uuid>
required

The ID of the sales order for that the creation of a PDF to start.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Query Parameters

formId
string<uuid>

Gets the unique identifier for the form (Formular) entity.

Represents a unique key for identifying a form (Formular) entity within the system.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Response

The filestream of the created PDF.

The response is of type string<byte>.