Skip to main content
GET
/
salesOrders
/
{salesOrderId}
/
lineitems
Query Sales Order Line Items
curl --request GET \
  --url https://api.jtl-cloud.com/erp/salesOrders/{salesOrderId}/lineitems \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-tenant-id: <x-tenant-id>'
[
  {
    "Id": 123,
    "SalesOrderId": 123,
    "ItemId": 123,
    "Name": "Awesome Binoculars",
    "SKU": "ART2394871",
    "Type": 0,
    "Quantity": 2,
    "QuantityDelivered": 2,
    "QuantityReturned": 1,
    "SalesUnit": "stk",
    "SalesPriceNet": 16.8,
    "SalesPriceGross": 19.99,
    "Discount": 5,
    "PurchasePriceNet": 13.46,
    "TaxRate": 19,
    "Notice": "Without sugar"
  }
]

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

Response

The requested line items.

​
Id
integer<int32>
required
​
SalesOrderId
integer<int32>
required
​
ItemId
integer<int32>
required
​
Name
string
required

Name of the position.

Example:

"Awesome Binoculars"

​
SKU
string
required

SKU of the sales order line item.

Example:

"ART2394871"

​
Type
enum<integer>
required

0 = Blank, 1 = Item, 2 = Shipping, 3 = Coupon, 4 = Voucher, 5 = Payment, 6 = ShippingSurcharge, 7 = NewCustomerCoupon, 8 = CashOnDelivery, 9 = ShippingSurchargeItem, 10 = Packing, 11 = GiftForFree, 12 = TrustedShops, 13 = InterestPremium, 14 = ProcessingFee, 15 = Carton, 16 = ReturnDelivery, 17 = MultiPurposeVoucher, 18 = MultiPurposeVoucherDigital, 19 = SinglePurposeVoucher, 20 = SinglePurposeVoucherDigital, 21 = SinglePurposeVoucherRedemption

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21
​
Quantity
number<decimal>
required

The quantity of the line item.

Example:

2

​
QuantityDelivered
number<decimal>
required

The quantity of the line item that has been delivered.

Example:

2

​
QuantityReturned
number<decimal>
required

The quantity of the line item that has been returned.

Example:

1

​
SalesUnit
string
required

The sales unit of the line item.

Example:

"stk"

​
SalesPriceNet
number<decimal>
required

The net sales price of the item. Only net or gross price can be entered. The other price will then be calculated.

Example:

16.8

​
SalesPriceGross
number<decimal>
required

The gross sales price of the item. Only net or gross price can be entered. The other price will then be calculated.

Example:

19.99

​
Discount
number<decimal>
required

The discount of the line item.

Example:

5

​
PurchasePriceNet
number<decimal>
required

The purchase price of the item.

Example:

13.46

​
TaxRate
number<decimal>
required

The tax rate of the line item.

Example:

19

​
Notice
string
required

Notice for the line item.

Example:

"Without sugar"