Sign in

v1

latestOpenAPI 3.0.22026-07-223907721.1 MB
salesorder

Query Sales Order Line Items

Query all line items for a specific sales order

get/v2/salesOrders/{salesOrderId}/lineitems

Path parameters

salesOrderIdstring uuid required
Example:b45f6432-2462-4c6f-b00f-1d9d01000000

The id of the sales order that the line items belong to.

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-runasstring

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

x-companyidstring

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

Response

The requested line items.

idstring uuid
salesOrderIdstring uuid
itemIdstring uuid
namestring

Name of the position.

sKUstring

SKU of the sales order line item.

type0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21

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

quantitynumber

The quantity of the line item.

quantityDeliverednumber

The quantity of the line item that has been delivered.

quantityReturnednumber

The quantity of the line item that has been returned.

salesUnitstring

The sales unit of the line item.

salesPriceNetnumber

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

salesPriceGrossnumber

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

discountnumber

The discount of the line item.

purchasePriceNetnumber

The purchase price of the item.

taxRatenumber

The tax rate of the line item.

noticestring

Notice for the line item.

Example response

[
  {
    "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salesOrderId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
  }
]