Skip to main content
PATCH
/
salesOrders
/
{salesOrderId}
/
files
/
{salesOrderFileId}
Update Sales Order File
curl --request PATCH \
  --url https://api.jtl-cloud.com/erp/salesOrders/{salesOrderId}/files/{salesOrderFileId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "FileData": "aSDinaTvuI8gbWludGxpZnk=",
  "FileDataType": "png",
  "FileName": "Attachment FileName"
}
'
{
  "Id": 123,
  "SalesOrderId": 123,
  "FileId": 123,
  "FileDataType": "png",
  "Size": "TODO",
  "CreatedAt": "TODO",
  "FileName": "Anhangdateiname"
}

Authorizations

​
Authorization
string
header
required

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

​
x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

​
api-version
string

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

​
x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

​
x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
X-SessionId
string<uuid>

The id of a session in which the call will be executed.

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

​
salesOrderId
integer<int32>
required
​
salesOrderFileId
integer<int32>
required

Body

application/json

The file to create.

Model Class: UpdateFile

​
FileData
string<byte>
​
FileDataType
string
Example:

"png"

​
FileName
string
Example:

"Attachment FileName"

Response

The updated sales order file.

Model Class: SalesOrderFile

​
Id
integer<int32>
required
​
SalesOrderId
integer<int32>
required
​
FileId
integer<int32>
required
​
FileDataType
string
required

Type of file.

Example:

"png"

​
Size
number<decimal>
required

Image size.

Example:

"TODO"

​
CreatedAt
string<date-time>
required

Date when the file was created in the system.

Example:

"TODO"

​
FileName
string
required

name of the file.

Example:

"Anhangdateiname"