Skip to main content
POST
/
v2
/
salesOrders
/
{salesOrderId}
/
notes
Create Sales Order Note
curl --request POST \
  --url https://api.jtl-cloud.com/erp/v2/salesOrders/{salesOrderId}/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "noteBody": "<string>"
}
'
{
  "noteId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "noteBody": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

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

​
x-companyid
string

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

Path Parameters

​
salesOrderId
string<uuid>
required

The id of the sales order that the notes belong to.

Example:

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

Body

application/json

The note of the sales order to create.

Model Class: CreateNote

​
noteBody
string

The text in the customer note.

Response

The created note of the sales order.

Model Class: Note

​
noteId
string<uuid>

Unique ID to identify a customer note. A customer note always has a customer reference and may have a sales order reference as well.

Example:

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

​
noteBody
string

The text in the customer note.